From 8e45b55152874d4b4b93e1a29604ca03dc887d6e Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Wed, 6 Nov 2019 10:33:58 -0800 Subject: [PATCH] feat!: run the generator (#1873) The following APIs have been removed: - dfareporting/v3.1 - dfareporting/v3.2 - speech/v2beta - urlshortener/v1 The following APIs have been added: - bigqueryreservation/v1beta1 - lifesciences/v2beta - monitoring/v1 - policytroubleshooter/v1beta - recommender/v1beta1 - run/v1beta1.ts - speech/v2beta1.ts - sql/v1beta4 --- src/apis/accessapproval/v1beta1.ts | 276 +- src/apis/accesscontextmanager/v1.ts | 2 +- src/apis/accesscontextmanager/v1beta.ts | 36 +- src/apis/adexchangebuyer/v1.4.ts | 2 +- src/apis/adexchangebuyer2/v2beta1.ts | 2 +- src/apis/admin/datatransfer_v1.ts | 18 +- src/apis/admin/directory_v1.ts | 4 +- src/apis/admin/reports_v1.ts | 203 +- src/apis/androidmanagement/v1.ts | 8 +- src/apis/androidpublisher/v3.ts | 8 + src/apis/appengine/v1.ts | 2 +- src/apis/appengine/v1beta.ts | 2 +- src/apis/bigquery/v2.ts | 161 +- src/apis/bigqueryconnection/v1beta1.ts | 18 +- src/apis/bigquerydatatransfer/v1.ts | 108 +- src/apis/bigqueryreservation/index.ts | 11 + src/apis/bigqueryreservation/v1.ts | 8 +- src/apis/bigqueryreservation/v1alpha2.ts | 447 - src/apis/bigqueryreservation/v1beta1.ts | 1963 + src/apis/bigtableadmin/v1.ts | 2 +- src/apis/bigtableadmin/v2.ts | 10 +- src/apis/binaryauthorization/v1.ts | 662 + src/apis/binaryauthorization/v1beta1.ts | 12 +- src/apis/blogger/v3.ts | 16 +- src/apis/calendar/v3.ts | 2 +- src/apis/civicinfo/v2.ts | 4 +- src/apis/cloudasset/v1.ts | 28 +- src/apis/cloudasset/v1beta1.ts | 16 +- src/apis/cloudbilling/v1.ts | 16 +- src/apis/clouddebugger/v2.ts | 60 +- src/apis/clouderrorreporting/v1beta1.ts | 92 +- src/apis/cloudfunctions/v1.ts | 42 +- src/apis/cloudfunctions/v1beta2.ts | 42 +- src/apis/cloudidentity/v1.ts | 24 +- src/apis/cloudidentity/v1beta1.ts | 28 +- src/apis/cloudiot/v1.ts | 88 +- src/apis/cloudkms/v1.ts | 112 +- .../cloudprivatecatalogproducer/v1beta1.ts | 8 +- src/apis/cloudresourcemanager/v1.ts | 14 +- src/apis/cloudresourcemanager/v1beta1.ts | 8 +- src/apis/cloudresourcemanager/v2.ts | 60 +- src/apis/cloudresourcemanager/v2beta1.ts | 60 +- src/apis/cloudsearch/v1.ts | 1088 +- src/apis/cloudshell/v1.ts | 14 +- src/apis/cloudshell/v1alpha1.ts | 14 +- src/apis/cloudtasks/v2.ts | 8 +- src/apis/cloudtasks/v2beta2.ts | 8 +- src/apis/cloudtasks/v2beta3.ts | 8 +- src/apis/cloudtrace/v1.ts | 38 +- src/apis/cloudtrace/v2.ts | 8 +- src/apis/commentanalyzer/v1alpha1.ts | 2 +- src/apis/compute/alpha.ts | 1624 +- src/apis/compute/beta.ts | 3047 +- src/apis/compute/v1.ts | 1661 +- src/apis/container/v1.ts | 162 +- src/apis/container/v1beta1.ts | 81 +- src/apis/containeranalysis/v1alpha1.ts | 14 +- src/apis/containeranalysis/v1beta1.ts | 12 +- src/apis/content/v2.1.ts | 42 +- src/apis/content/v2.ts | 1225 +- src/apis/dataflow/v1b3.ts | 22 +- src/apis/datafusion/v1beta1.ts | 64 +- src/apis/dataproc/v1.ts | 27 +- src/apis/dataproc/v1beta2.ts | 26 +- src/apis/datastore/v1.ts | 198 +- src/apis/datastore/v1beta3.ts | 2 +- src/apis/dfareporting/index.ts | 27 +- src/apis/dfareporting/v3.1.ts | 37621 ---------------- src/apis/dfareporting/v3.2.ts | 27675 ------------ src/apis/dlp/v2.ts | 207 +- src/apis/dns/v1.ts | 4 + src/apis/dns/v2beta1.ts | 4 + src/apis/docs/v1.ts | 73 + src/apis/drive/v2.ts | 16 +- src/apis/drive/v3.ts | 18 +- src/apis/fcm/v1.ts | 6 +- src/apis/file/v1.ts | 8 +- src/apis/file/v1beta1.ts | 8 +- src/apis/firebase/v1beta1.ts | 16 +- src/apis/firebasehosting/v1beta1.ts | 17 + src/apis/fitness/v1.ts | 2 +- src/apis/games/v1.ts | 454 +- src/apis/gamesManagement/v1management.ts | 425 +- src/apis/healthcare/v1beta1.ts | 596 +- src/apis/iam/v1.ts | 21 +- src/apis/iap/v1.ts | 274 +- src/apis/iap/v1beta1.ts | 8 +- src/apis/index.ts | 15 +- src/apis/jobs/v2.ts | 70 + src/apis/jobs/v3.ts | 74 + src/apis/jobs/v3p1beta1.ts | 74 + src/apis/licensing/README.md | 2 +- src/apis/licensing/v1.ts | 122 +- src/apis/lifesciences/README.md | 47 + src/apis/lifesciences/index.ts | 37 + .../package.json | 4 +- .../tsconfig.json | 0 src/apis/lifesciences/v2beta.ts | 1303 + .../webpack.config.js | 4 +- src/apis/logging/v2.ts | 26 +- src/apis/ml/v1.ts | 38 +- src/apis/monitoring/index.ts | 12 +- src/apis/monitoring/v1.ts | 231 + src/apis/monitoring/v3.ts | 32 +- src/apis/oslogin/README.md | 2 +- src/apis/oslogin/v1.ts | 34 +- src/apis/oslogin/v1alpha.ts | 8 + src/apis/oslogin/v1beta.ts | 30 +- src/apis/people/v1.ts | 212 +- .../README.md | 12 +- src/apis/policytroubleshooter/index.ts | 39 + src/apis/policytroubleshooter/package.json | 43 + src/apis/policytroubleshooter/tsconfig.json | 10 + src/apis/policytroubleshooter/v1beta.ts | 436 + .../policytroubleshooter/webpack.config.js | 71 + src/apis/pubsub/v1.ts | 14 +- src/apis/pubsub/v1beta2.ts | 12 +- src/apis/recommender/README.md | 47 + src/apis/recommender/index.ts | 37 + src/apis/recommender/package.json | 43 + src/apis/recommender/tsconfig.json | 10 + src/apis/recommender/v1beta1.ts | 968 + src/apis/recommender/webpack.config.js | 71 + src/apis/redis/v1.ts | 24 +- src/apis/redis/v1beta1.ts | 24 +- src/apis/remotebuildexecution/v1.ts | 416 +- src/apis/remotebuildexecution/v1alpha.ts | 278 +- src/apis/remotebuildexecution/v2.ts | 278 +- src/apis/reseller/v1.ts | 2 +- src/apis/run/index.ts | 14 +- src/apis/run/v1.ts | 7745 +++- src/apis/run/v1alpha1.ts | 1461 +- src/apis/run/v1beta1.ts | 1009 + src/apis/runtimeconfig/v1beta1.ts | 10 +- src/apis/safebrowsing/v4.ts | 2 +- src/apis/securitycenter/v1.ts | 112 +- src/apis/securitycenter/v1beta1.ts | 104 +- src/apis/servicebroker/v1.ts | 10 +- src/apis/servicebroker/v1alpha1.ts | 10 +- src/apis/servicebroker/v1beta1.ts | 10 +- src/apis/serviceconsumermanagement/v1.ts | 36 +- src/apis/servicecontrol/v1.ts | 6 +- src/apis/servicemanagement/v1.ts | 110 +- src/apis/servicenetworking/v1.ts | 6 +- src/apis/servicenetworking/v1beta.ts | 6 +- src/apis/serviceusage/v1.ts | 32 +- src/apis/serviceusage/v1beta1.ts | 32 +- src/apis/sheets/v4.ts | 217 + src/apis/spanner/v1.ts | 8 +- src/apis/speech/index.ts | 14 +- src/apis/speech/v1.ts | 73 +- src/apis/speech/v1p1beta1.ts | 74 +- src/apis/speech/{v2beta.ts => v2beta1.ts} | 20 +- src/apis/sql/README.md | 47 + src/apis/{urlshortener => sql}/index.ts | 16 +- src/apis/sql/package.json | 43 + src/apis/sql/tsconfig.json | 10 + src/apis/sql/v1beta4.ts | 5856 +++ src/apis/sql/webpack.config.js | 71 + src/apis/streetviewpublish/v1.ts | 22 +- src/apis/testing/v1.ts | 88 +- src/apis/texttospeech/v1.ts | 12 +- src/apis/texttospeech/v1beta1.ts | 12 +- src/apis/toolresults/v1beta3.ts | 4 +- src/apis/translate/v3beta1.ts | 52 +- src/apis/urlshortener/v1.ts | 476 - src/apis/vault/v1.ts | 91 + src/apis/videointelligence/v1.ts | 48 +- src/apis/videointelligence/v1beta2.ts | 48 +- src/apis/videointelligence/v1p1beta1.ts | 48 +- src/apis/videointelligence/v1p2beta1.ts | 48 +- src/apis/videointelligence/v1p3beta1.ts | 48 +- src/apis/vision/v1.ts | 1453 +- src/apis/vision/v1p1beta1.ts | 1379 +- src/apis/vision/v1p2beta1.ts | 1379 +- src/apis/websecurityscanner/v1alpha.ts | 56 +- src/apis/websecurityscanner/v1beta.ts | 80 +- src/index.ts | 12 +- 178 files changed, 31880 insertions(+), 77412 deletions(-) create mode 100644 src/apis/bigqueryreservation/v1beta1.ts delete mode 100644 src/apis/dfareporting/v3.1.ts delete mode 100644 src/apis/dfareporting/v3.2.ts create mode 100644 src/apis/lifesciences/README.md create mode 100644 src/apis/lifesciences/index.ts rename src/apis/{urlshortener => lifesciences}/package.json (93%) rename src/apis/{urlshortener => lifesciences}/tsconfig.json (100%) create mode 100644 src/apis/lifesciences/v2beta.ts rename src/apis/{urlshortener => lifesciences}/webpack.config.js (96%) create mode 100644 src/apis/monitoring/v1.ts rename src/apis/{urlshortener => policytroubleshooter}/README.md (82%) create mode 100644 src/apis/policytroubleshooter/index.ts create mode 100644 src/apis/policytroubleshooter/package.json create mode 100644 src/apis/policytroubleshooter/tsconfig.json create mode 100644 src/apis/policytroubleshooter/v1beta.ts create mode 100644 src/apis/policytroubleshooter/webpack.config.js create mode 100644 src/apis/recommender/README.md create mode 100644 src/apis/recommender/index.ts create mode 100644 src/apis/recommender/package.json create mode 100644 src/apis/recommender/tsconfig.json create mode 100644 src/apis/recommender/v1beta1.ts create mode 100644 src/apis/recommender/webpack.config.js create mode 100644 src/apis/run/v1beta1.ts rename src/apis/speech/{v2beta.ts => v2beta1.ts} (97%) create mode 100644 src/apis/sql/README.md rename src/apis/{urlshortener => sql}/index.ts (64%) create mode 100644 src/apis/sql/package.json create mode 100644 src/apis/sql/tsconfig.json create mode 100644 src/apis/sql/v1beta4.ts create mode 100644 src/apis/sql/webpack.config.js delete mode 100644 src/apis/urlshortener/v1.ts diff --git a/src/apis/accessapproval/v1beta1.ts b/src/apis/accessapproval/v1beta1.ts index 3978e4d1ef4..fa23d202732 100644 --- a/src/apis/accessapproval/v1beta1.ts +++ b/src/apis/accessapproval/v1beta1.ts @@ -126,7 +126,11 @@ export namespace accessapproval_v1beta1 { */ export interface Schema$AccessApprovalSettings { /** - * 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. + * 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[]; /** @@ -134,7 +138,7 @@ export namespace accessapproval_v1beta1 { */ 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 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; } @@ -237,6 +241,10 @@ export namespace accessapproval_v1beta1 { */ 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. */ @@ -283,6 +291,78 @@ export namespace accessapproval_v1beta1 { ); } + /** + * 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 + '/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); + } + } + /** * accessapproval.folders.getAccessApprovalSettings * @desc Gets the settings associated with a project, folder, or organization. @@ -367,7 +447,7 @@ export namespace accessapproval_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The resource name of the settings. Format is one of:
  1. "projects/{project_id}/accessApprovalSettings"
  2. "folders/{folder_id}/accessApprovalSettings"
  3. "organizations/{organization_id}/accessApprovalSettings"
      4. - * @param {string=} params.updateMask The update mask applies to the settings. 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 {string=} params.updateMask 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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -438,6 +518,18 @@ export namespace accessapproval_v1beta1 { } } + 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 { /** @@ -462,7 +554,7 @@ export namespace accessapproval_v1beta1 { */ name?: string; /** - * The update mask applies to the settings. 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. + * 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; @@ -871,6 +963,78 @@ export namespace accessapproval_v1beta1 { ); } + /** + * 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 + '/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); + } + } + /** * accessapproval.organizations.getAccessApprovalSettings * @desc Gets the settings associated with a project, folder, or organization. @@ -955,7 +1119,7 @@ export namespace accessapproval_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The resource name of the settings. Format is one of:
      1. "projects/{project_id}/accessApprovalSettings"
      2. "folders/{folder_id}/accessApprovalSettings"
      3. "organizations/{organization_id}/accessApprovalSettings"
          4. - * @param {string=} params.updateMask The update mask applies to the settings. 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 {string=} params.updateMask 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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1026,6 +1190,18 @@ export namespace accessapproval_v1beta1 { } } + 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 { /** @@ -1050,7 +1226,7 @@ export namespace accessapproval_v1beta1 { */ name?: string; /** - * The update mask applies to the settings. 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. + * 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; @@ -1459,6 +1635,78 @@ export namespace accessapproval_v1beta1 { ); } + /** + * 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 + '/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); + } + } + /** * accessapproval.projects.getAccessApprovalSettings * @desc Gets the settings associated with a project, folder, or organization. @@ -1543,7 +1791,7 @@ export namespace accessapproval_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The resource name of the settings. Format is one of:
          1. "projects/{project_id}/accessApprovalSettings"
          2. "folders/{folder_id}/accessApprovalSettings"
          3. "organizations/{organization_id}/accessApprovalSettings"
              4. - * @param {string=} params.updateMask The update mask applies to the settings. 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 {string=} params.updateMask 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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1614,6 +1862,18 @@ export namespace accessapproval_v1beta1 { } } + 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 { /** @@ -1638,7 +1898,7 @@ export namespace accessapproval_v1beta1 { */ name?: string; /** - * The update mask applies to the settings. 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. + * 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; diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 5b2cace0afd..a2703025dfa 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -342,7 +342,7 @@ export namespace accesscontextmanager_v1 { */ osType?: string | null; /** - * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request. + * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request. */ requireVerifiedChromeOs?: boolean | null; } diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts index 9fcd76a4ed7..af12e436561 100644 --- a/src/apis/accesscontextmanager/v1beta.ts +++ b/src/apis/accesscontextmanager/v1beta.ts @@ -186,19 +186,6 @@ export namespace accesscontextmanager_v1beta { */ conditions?: Schema$Condition[]; } - /** - * Alpha. Specifies which services are granted access via this Bridge Service Perimeter. - */ - export interface Schema$BridgeServiceRestriction { - /** - * The list of APIs usable through the Bridge Perimeter. Must be empty unless 'enable_restriction' is True. - */ - allowedServices?: string[] | null; - /** - * Whether to restrict the set of APIs callable through the Bridge Service Perimeter. - */ - enableRestriction?: boolean | null; - } /** * 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. */ @@ -257,19 +244,6 @@ export namespace accesscontextmanager_v1beta { */ requireScreenlock?: boolean | null; } - /** - * Alpha. Specifies how Access Levels are to be used for accessing the Service Perimeter. - */ - export interface Schema$IngressServiceRestriction { - /** - * The list of APIs usable with a valid Access Level. Must be empty unless 'enable_restriction' is True. - */ - allowedServices?: string[] | null; - /** - * Whether to restrict the set of APIs callable outside the Service Perimeter via Access Levels. - */ - enableRestriction?: boolean | null; - } /** * A response to `ListAccessLevelsRequest`. */ @@ -347,7 +321,7 @@ export namespace accesscontextmanager_v1beta { */ osType?: string | null; /** - * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request. + * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request. */ requireVerifiedChromeOs?: boolean | null; } @@ -392,14 +366,6 @@ export namespace accesscontextmanager_v1beta { * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ accessLevels?: string[] | null; - /** - * Alpha. Configuration for what services are accessible via the Bridge Perimeter. Must be empty for non-Bridge Perimeters. - */ - bridgeServiceRestriction?: Schema$BridgeServiceRestriction; - /** - * Alpha. Configuration for which services may be used with Access Levels. - */ - ingressServiceRestriction?: Schema$IngressServiceRestriction; /** * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ diff --git a/src/apis/adexchangebuyer/v1.4.ts b/src/apis/adexchangebuyer/v1.4.ts index b6f8fca58d3..119a857611e 100644 --- a/src/apis/adexchangebuyer/v1.4.ts +++ b/src/apis/adexchangebuyer/v1.4.ts @@ -535,7 +535,7 @@ export namespace adexchangebuyer_v1_4 { } export interface Schema$DealTerms { /** - * Visibilty of the URL in bid requests. + * Visibility of the URL in bid requests. */ brandingType?: string | null; /** diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 7e6a3ab1e08..ecb63a3c7e6 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -224,7 +224,7 @@ export namespace adexchangebuyer2_v2beta1 { */ billedImpressions?: Schema$MetricValue; /** - * The number of bids that won an impression. + * The number of bids that won the auction. */ impressionsWon?: Schema$MetricValue; /** diff --git a/src/apis/admin/datatransfer_v1.ts b/src/apis/admin/datatransfer_v1.ts index c79cf87f719..2404e4c389e 100644 --- a/src/apis/admin/datatransfer_v1.ts +++ b/src/apis/admin/datatransfer_v1.ts @@ -124,7 +124,7 @@ export namespace admin_datatransfer_v1 { */ name?: string | null; /** - * The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered. + * The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transferred. */ transferParams?: Schema$ApplicationTransferParam[]; } @@ -137,7 +137,7 @@ export namespace admin_datatransfer_v1 { */ applicationId?: string | null; /** - * The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application. + * The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. */ applicationTransferParams?: Schema$ApplicationTransferParam[]; /** @@ -175,7 +175,7 @@ export namespace admin_datatransfer_v1 { */ key?: string | null; /** - * The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED' + * The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED' */ value?: string[] | null; } @@ -200,11 +200,11 @@ export namespace admin_datatransfer_v1 { */ kind?: string | null; /** - * ID of the user to whom the data is being transfered. + * ID of the user to whom the data is being transferred. */ newOwnerUserId?: string | null; /** - * ID of the user whose data is being transfered. + * ID of the user whose data is being transferred. */ oldOwnerUserId?: string | null; /** @@ -323,7 +323,7 @@ export namespace admin_datatransfer_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.customerId Immutable ID of the Google Apps account. + * @param {string=} params.customerId Immutable ID of the G Suite account. * @param {integer=} params.maxResults Maximum number of results to return. Default is 100. * @param {string=} params.pageToken Token to specify next page in the list. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -414,7 +414,7 @@ export namespace admin_datatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Immutable ID of the Google Apps account. + * Immutable ID of the G Suite account. */ customerId?: string; /** @@ -585,7 +585,7 @@ export namespace admin_datatransfer_v1 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.customerId Immutable ID of the Google Apps account. + * @param {string=} params.customerId Immutable ID of the G Suite account. * @param {integer=} params.maxResults Maximum number of results to return. Default is 100. * @param {string=} params.newOwnerUserId Destination user's profile ID. * @param {string=} params.oldOwnerUserId Source user's profile ID. @@ -693,7 +693,7 @@ export namespace admin_datatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Immutable ID of the Google Apps account. + * Immutable ID of the G Suite account. */ customerId?: string; /** diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 9457c1c8a66..5fa27ec49df 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -571,7 +571,7 @@ export namespace admin_directory_v1 { */ ethernetMacAddress?: string | null; /** - * (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices. + * (Read-only) MAC address used by the Chromebook’s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices. */ ethernetMacAddress0?: string | null; /** @@ -599,7 +599,7 @@ export namespace admin_directory_v1 { */ manufactureDate?: string | null; /** - * Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only) + * Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only) */ meid?: string | null; /** diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index b5b6a58f19f..815198869b6 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -120,15 +120,15 @@ export namespace admin_reports_v1 { */ etag?: string | null; /** - * Each record in read response. + * Each activity record in the response. */ items?: Schema$Activity[]; /** - * Kind of list response this is. + * The type of API resource. For an activity report, the value is reports#activities. */ kind?: string | null; /** - * Token for retrieving the next page + * Token for retrieving the follow-on next page of the report. The nextPageToken value is used in the request's pageToken query string. */ nextPageToken?: string | null; } @@ -150,7 +150,7 @@ export namespace admin_reports_v1 { */ etag?: string | null; /** - * Activity events. + * Activity events in the report. */ events?: Array<{ name?: string; @@ -176,15 +176,15 @@ export namespace admin_reports_v1 { uniqueQualifier?: string; } | null; /** - * IP Address of the user doing the action. + * IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into G Suite which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6. */ ipAddress?: string | null; /** - * Kind of resource this is. + * The type of API resource. For an activity report, the value is audit#activity. */ kind?: string | null; /** - * Domain of source customer. + * This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner. */ ownerDomain?: string | null; } @@ -242,7 +242,7 @@ export namespace admin_reports_v1 { */ boolValue?: boolean | null; /** - * Integral value of the parameter. + * Integer value of the parameter. */ intValue?: string | null; /** @@ -250,7 +250,7 @@ export namespace admin_reports_v1 { */ multiBoolValue?: boolean[] | null; /** - * Multiple integral values of the parameter. + * Multiple integer values of the parameter. */ multiIntValue?: string[] | null; /** @@ -271,7 +271,7 @@ export namespace admin_reports_v1 { */ export interface Schema$UsageReport { /** - * The date to which the record belongs. + * The date of the report request. */ date?: string | null; /** @@ -289,11 +289,11 @@ export namespace admin_reports_v1 { */ etag?: string | null; /** - * The kind of object. + * The type of API resource. For a usage report, the value is admin#reports#usageReport. */ kind?: string | null; /** - * Parameter value pairs for various applications. + * Parameter value pairs for various applications. For the Customers usage report parameters and values, see the customer usage parameters reference. */ parameters?: Array<{ boolValue?: boolean; @@ -304,20 +304,17 @@ export namespace admin_reports_v1 { stringValue?: string; }> | null; } - /** - * JSON template for a collection of usage reports. - */ export interface Schema$UsageReports { /** * ETag of the resource. */ etag?: string | null; /** - * The kind of object. + * The type of API resource. For a usage report, the value is admin#reports#usageReports. */ kind?: string | null; /** - * Token for retrieving the next page + * Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string. */ nextPageToken?: string | null; /** @@ -325,7 +322,7 @@ export namespace admin_reports_v1 { */ usageReports?: Schema$UsageReport[]; /** - * Warnings if any. + * Warnings, if any. */ warnings?: Array<{ code?: string; @@ -342,22 +339,22 @@ export namespace admin_reports_v1 { /** * reports.activities.list - * @desc Retrieves a list of activities for a specific customer and application. + * @desc Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides. * @alias reports.activities.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.actorIpAddress IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. + * @param {string=} params.actorIpAddress The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions. * @param {string} params.applicationName Application name for which the events are to be retrieved. - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string=} params.endTime Return events which occurred at or before this time. - * @param {string=} params.eventName Name of the event being queried. - * @param {string=} params.filters Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... - * @param {integer=} params.maxResults Number of activity records to be shown in each page. - * @param {string=} params.orgUnitID the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s) - * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.startTime Return events which occurred at or after this time. - * @param {string} params.userKey Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. + * @param {string=} params.customerId The unique ID of the customer to retrieve data for. + * @param {string=} params.endTime Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - Date of the API's request for a report: When the API created and retrieved the report. - Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. - Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past. + * @param {string=} params.eventName The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName. + * @param {string=} params.filters The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. + * @param {integer=} params.maxResults Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000. + * @param {string=} params.orgUnitID ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results. + * @param {string=} params.pageToken The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string. + * @param {string=} params.startTime Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. + * @param {string} params.userKey Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -425,22 +422,22 @@ export namespace admin_reports_v1 { /** * reports.activities.watch - * @desc Push changes to activities + * @desc Start receiving notifications for account activities. For more information, see Receiving Push Notifications. * @alias reports.activities.watch * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.actorIpAddress IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. + * @param {string=} params.actorIpAddress The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions. * @param {string} params.applicationName Application name for which the events are to be retrieved. - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string=} params.endTime Return events which occurred at or before this time. - * @param {string=} params.eventName Name of the event being queried. - * @param {string=} params.filters Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... - * @param {integer=} params.maxResults Number of activity records to be shown in each page. - * @param {string=} params.orgUnitID the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s) - * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.startTime Return events which occurred at or after this time. - * @param {string} params.userKey Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. + * @param {string=} params.customerId The unique ID of the customer to retrieve data for. + * @param {string=} params.endTime Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - Date of the API's request for a report: When the API created and retrieved the report. - Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. - Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past. + * @param {string=} params.eventName The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName. + * @param {string=} params.filters The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. + * @param {integer=} params.maxResults Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000. + * @param {string=} params.orgUnitID ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results. + * @param {string=} params.pageToken The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string. + * @param {string=} params.startTime Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. + * @param {string} params.userKey Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address. * @param {().Channel} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -513,7 +510,7 @@ export namespace admin_reports_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. + * The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions. */ actorIpAddress?: string; /** @@ -521,39 +518,39 @@ export namespace admin_reports_v1 { */ applicationName?: string; /** - * Represents the customer for which the data is to be fetched. + * The unique ID of the customer to retrieve data for. */ customerId?: string; /** - * Return events which occurred at or before this time. + * Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - Date of the API's request for a report: When the API created and retrieved the report. - Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. - Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past. */ endTime?: string; /** - * Name of the event being queried. + * The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName. */ eventName?: string; /** - * Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... + * The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. */ filters?: string; /** - * Number of activity records to be shown in each page. + * Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000. */ maxResults?: number; /** - * the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s) + * ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results. */ orgUnitID?: string; /** - * Token to specify next page. + * The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string. */ pageToken?: string; /** - * Return events which occurred at or after this time. + * Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. */ startTime?: string; /** - * Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. + * Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address. */ userKey?: string; } @@ -564,7 +561,7 @@ export namespace admin_reports_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses. + * The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions. */ actorIpAddress?: string; /** @@ -572,39 +569,39 @@ export namespace admin_reports_v1 { */ applicationName?: string; /** - * Represents the customer for which the data is to be fetched. + * The unique ID of the customer to retrieve data for. */ customerId?: string; /** - * Return events which occurred at or before this time. + * Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - Date of the API's request for a report: When the API created and retrieved the report. - Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. - Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past. */ endTime?: string; /** - * Name of the event being queried. + * The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName. */ eventName?: string; /** - * Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],... + * The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. */ filters?: string; /** - * Number of activity records to be shown in each page. + * Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000. */ maxResults?: number; /** - * the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s) + * ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results. */ orgUnitID?: string; /** - * Token to specify next page. + * The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string. */ pageToken?: string; /** - * Return events which occurred at or after this time. + * Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. */ startTime?: string; /** - * Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. + * Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address. */ userKey?: string; @@ -711,15 +708,15 @@ export namespace admin_reports_v1 { /** * reports.customerUsageReports.get - * @desc Retrieves a report which is a collection of properties / statistics for a specific customer. + * @desc Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides. * @alias reports.customerUsageReports.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string} params.date Represents the date in yyyy-mm-dd format for which the data is to be fetched. - * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.parameters Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. + * @param {string=} params.customerId The unique ID of the customer to retrieve data for. + * @param {string} params.date Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. + * @param {string=} params.pageToken Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string. + * @param {string=} params.parameters The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2. Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -795,19 +792,19 @@ export namespace admin_reports_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Represents the customer for which the data is to be fetched. + * The unique ID of the customer to retrieve data for. */ customerId?: string; /** - * Represents the date in yyyy-mm-dd format for which the data is to be fetched. + * Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. */ date?: string; /** - * Token to specify next page. + * Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string. */ pageToken?: string; /** - * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. + * The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2. Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. */ parameters?: string; } @@ -820,19 +817,19 @@ export namespace admin_reports_v1 { /** * reports.entityUsageReports.get - * @desc Retrieves a report which is a collection of properties / statistics for a set of objects. + * @desc Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides. * @alias reports.entityUsageReports.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string} params.date Represents the date in yyyy-mm-dd format for which the data is to be fetched. - * @param {string} params.entityKey Represents the key of object for which the data should be filtered. - * @param {string} params.entityType Type of object. Should be one of - gplus_communities. - * @param {string=} params.filters Represents the set of filters including parameter operator value. - * @param {integer=} params.maxResults Maximum number of results to return. Maximum allowed is 1000 - * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.parameters Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. + * @param {string=} params.customerId The unique ID of the customer to retrieve data for. + * @param {string} params.date Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. + * @param {string} params.entityKey Represents the key of the object to filter the data with. + * @param {string} params.entityType Represents the type of entity for the report. + * @param {string=} params.filters The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include accounts, docs, and gmail. Filters are in the form [application name]:[parameter name][relational operator][parameter value],.... In this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members>0 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters. + * @param {integer=} params.maxResults Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. + * @param {string=} params.pageToken Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string. + * @param {string=} params.parameters The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only gplus. A parameter query string is in the CSV form of [app_name1:param_name1], [app_name2:param_name2].... Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -908,35 +905,35 @@ export namespace admin_reports_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Represents the customer for which the data is to be fetched. + * The unique ID of the customer to retrieve data for. */ customerId?: string; /** - * Represents the date in yyyy-mm-dd format for which the data is to be fetched. + * Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. */ date?: string; /** - * Represents the key of object for which the data should be filtered. + * Represents the key of the object to filter the data with. */ entityKey?: string; /** - * Type of object. Should be one of - gplus_communities. + * Represents the type of entity for the report. */ entityType?: string; /** - * Represents the set of filters including parameter operator value. + * The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include accounts, docs, and gmail. Filters are in the form [application name]:[parameter name][relational operator][parameter value],.... In this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members>0 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters. */ filters?: string; /** - * Maximum number of results to return. Maximum allowed is 1000 + * Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. */ maxResults?: number; /** - * Token to specify next page. + * Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string. */ pageToken?: string; /** - * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. + * The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only gplus. A parameter query string is in the CSV form of [app_name1:param_name1], [app_name2:param_name2].... Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. */ parameters?: string; } @@ -949,19 +946,19 @@ export namespace admin_reports_v1 { /** * reports.userUsageReport.get - * @desc Retrieves a report which is a collection of properties / statistics for a set of users. + * @desc Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides. * @alias reports.userUsageReport.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.customerId Represents the customer for which the data is to be fetched. - * @param {string} params.date Represents the date in yyyy-mm-dd format for which the data is to be fetched. - * @param {string=} params.filters Represents the set of filters including parameter operator value. - * @param {integer=} params.maxResults Maximum number of results to return. Maximum allowed is 1000 - * @param {string=} params.orgUnitID the organizational unit's ID to filter usage parameters from users belonging to a specific OU or one of its sub-OU(s). - * @param {string=} params.pageToken Token to specify next page. - * @param {string=} params.parameters Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. - * @param {string} params.userKey Represents the profile id or the user email for which the data should be filtered. + * @param {string=} params.customerId The unique ID of the customer to retrieve data for. + * @param {string} params.date Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. + * @param {string=} params.filters The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include accounts, docs, and gmail. Filters are in the form [application name]:[parameter name][relational operator][parameter value],.... In this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010-10-28T10:26:35.000Z The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). + * @param {integer=} params.maxResults Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional. + * @param {string=} params.orgUnitID ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results. + * @param {string=} params.pageToken Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string. + * @param {string=} params.parameters The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2. Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. + * @param {string} params.userKey Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1036,35 +1033,35 @@ export namespace admin_reports_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Represents the customer for which the data is to be fetched. + * The unique ID of the customer to retrieve data for. */ customerId?: string; /** - * Represents the date in yyyy-mm-dd format for which the data is to be fetched. + * Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this. */ date?: string; /** - * Represents the set of filters including parameter operator value. + * The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include accounts, docs, and gmail. Filters are in the form [application name]:[parameter name][relational operator][parameter value],.... In this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010-10-28T10:26:35.000Z The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). */ filters?: string; /** - * Maximum number of results to return. Maximum allowed is 1000 + * Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional. */ maxResults?: number; /** - * the organizational unit's ID to filter usage parameters from users belonging to a specific OU or one of its sub-OU(s). + * ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results. */ orgUnitID?: string; /** - * Token to specify next page. + * Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string. */ pageToken?: string; /** - * Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2. + * The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2. Note: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. */ parameters?: string; /** - * Represents the profile id or the user email for which the data should be filtered. + * Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address. */ userKey?: string; } diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 566ffe4c14c..70a713afa6d 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -1152,7 +1152,7 @@ export namespace androidmanagement_v1 { receiverActivity?: string | null; } /** - * A policy resources represents a group settings that govern the behavior of a managed device and the apps installed on it. + * A policy resource represents a group of settings that govern the behavior of a managed device and the apps installed on it. */ export interface Schema$Policy { /** @@ -1348,7 +1348,7 @@ export namespace androidmanagement_v1 { */ permissionGrants?: Schema$PermissionGrant[]; /** - * Specifies permitted accessibility services. If the field is not set, any accessibility service can be used. If the field is set, only the accessibility services in this list and the system's built-in accessibility services can be used. In particular, if the field is set to empty, only the system's built-in accessibility services can be used. + * Specifies permitted accessibility services. If the field is not set, any accessibility service can be used. If the field is set, only the accessibility services in this list and the system's built-in accessibility service can be used. In particular, if the field is set to empty, only the system's built-in accessibility servicess can be used. */ permittedAccessibilityServices?: Schema$PackageNameList; /** @@ -1797,6 +1797,10 @@ export namespace androidmanagement_v1 { * A web token used to access the managed Google Play iframe. */ export interface Schema$WebToken { + /** + * The features to enable. Use this if you want to control exactly which feature(s) will be activated; leave empty to allow all features.Restrictions / things to note: <ul> <li> If no features are listed here, all features are enabled — this is the default behavior where you give access to all features to your admins. <li> This must not contain any FEATURE_UNSPECIFIED values. <li> Repeated values are ignored </ul> + */ + enabledFeatures?: string[] | null; /** * The name of the web token, which is generated by the server during creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}. */ diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 40b97fe938e..2346f3a03ae 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -593,6 +593,10 @@ export namespace androidpublisher_v3 { * The order id associated with the purchase of the inapp product. */ orderId?: string | null; + /** + * The inapp product SKU. + */ + productId?: string | null; /** * The purchase state of the order. Possible values are: - Purchased - Canceled - Pending */ @@ -601,6 +605,10 @@ export namespace androidpublisher_v3 { * The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970). */ purchaseTimeMillis?: string | null; + /** + * The purchase token generated to identify this purchase. + */ + purchaseToken?: string | null; /** * The type of purchase of the inapp product. 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) - Rewarded (i.e. from watching a video ad instead of paying) */ diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 8bac4c2ddcf..c687eb1bb22 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -5044,7 +5044,7 @@ export namespace appengine_v1 { /** * appengine.apps.services.versions.instances.delete - * @desc Stops a running instance. + * @desc Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method. * @alias appengine.apps.services.versions.instances.delete * @memberOf! () * diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 136f18f6b42..e23d227b840 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -5107,7 +5107,7 @@ export namespace appengine_v1beta { /** * appengine.apps.services.versions.instances.delete - * @desc Stops a running instance. + * @desc Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method. * @alias appengine.apps.services.versions.instances.delete * @memberOf! () * diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 3a1563b4f94..e6219aed057 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -167,6 +167,87 @@ export namespace bigquery_v2 { */ name?: string | null; } + /** + * Arima coefficients. + */ + export interface Schema$ArimaCoefficients { + /** + * Auto-regressive coefficients, an array of double. + */ + autoRegressiveCoefficients?: number[] | null; + /** + * Intercept coefficient, just a double not an array. + */ + interceptCoefficient?: number | null; + /** + * Moving-average coefficients, an array of double. + */ + movingAverageCoefficients?: number[] | null; + } + /** + * ARIMA model fitting metrics. + */ + export interface Schema$ArimaFittingMetrics { + /** + * AIC + */ + aic?: number | null; + /** + * log-likelihood + */ + logLikelihood?: number | null; + /** + * variance. + */ + variance?: number | null; + } + /** + * Arima model information. + */ + export interface Schema$ArimaModelInfo { + /** + * Arima coefficients. + */ + arimaCoefficients?: Schema$ArimaCoefficients; + /** + * Arima fitting metrics. + */ + arimaFittingMetrics?: Schema$ArimaFittingMetrics; + /** + * Non-seasonal order. + */ + nonSeasonalOrder?: Schema$ArimaOrder; + } + /** + * Arima order, can be used for both non-seasonal and seasonal parts. + */ + export interface Schema$ArimaOrder { + /** + * Order of the differencing part. + */ + d?: string | null; + /** + * Order of the autoregressive part. + */ + p?: string | null; + /** + * Order of the moving-average part. + */ + q?: string | null; + } + /** + * (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results. + */ + export interface Schema$ArimaResult { + /** + * This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one. + */ + arimaModelInfo?: Schema$ArimaModelInfo[]; + /** + * Seasonal periods. Repeated because multiple periods are supported for one time series. + */ + seasonalPeriods?: string[] | null; + } export interface Schema$BigQueryModelTraining { /** * [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. @@ -462,7 +543,7 @@ export namespace bigquery_v2 { */ quote?: string | null; /** - * [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. + * [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. */ skipLeadingRows?: string | null; } @@ -471,13 +552,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<{ + iamMember?: string; + specialGroup?: string; role?: string; view?: Schema$TableReference; groupByEmail?: string; - domain?: string; userByEmail?: string; - iamMember?: string; - specialGroup?: string; + domain?: string; }> | null; /** * [Output-only] The time when this dataset was created, in milliseconds since the epoch. @@ -538,12 +619,12 @@ export namespace bigquery_v2 { * An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. */ datasets?: Array<{ + labels?: {[key: string]: string}; datasetReference?: Schema$DatasetReference; id?: string; location?: string; friendlyName?: string; kind?: string; - labels?: {[key: string]: string}; }> | null; /** * A hash value of the results page. You can use this property to determine if the page has changed since the last request. @@ -790,7 +871,7 @@ export namespace bigquery_v2 { */ googleSheetsOptions?: Schema$GoogleSheetsOptions; /** - * [Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. Note: this setting is in the process of being deprecated in favor of hivePartitioningOptions. + * [Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead. */ hivePartitioningMode?: string | null; /** @@ -919,6 +1000,7 @@ export namespace bigquery_v2 { * Information about a single iteration of the training run. */ export interface Schema$IterationResult { + arimaResult?: Schema$ArimaResult; /** * Information about top clusters for clustering models. */ @@ -1106,7 +1188,7 @@ export namespace bigquery_v2 { */ fieldDelimiter?: string | null; /** - * [Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. + * [Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead. */ hivePartitioningMode?: string | null; /** @@ -1310,8 +1392,8 @@ export namespace bigquery_v2 { id?: string; configuration?: Schema$JobConfiguration; user_email?: string; - kind?: string; errorResult?: Schema$ErrorProto; + kind?: string; }> | null; /** * The resource type of the response. @@ -1381,6 +1463,10 @@ export namespace bigquery_v2 { * [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. */ reservation_id?: string | null; + /** + * [Output-only] Statistics for a child job of a script. + */ + scriptStatistics?: Schema$ScriptStatistics; /** * [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. */ @@ -1450,13 +1536,13 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{name?: string; slotMs?: string}> | null; + reservationUsage?: Array<{slotMs?: string; name?: string}> | null; /** * [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. */ schema?: Schema$TableSchema; /** - * The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. + * The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query. */ statementType?: string | null; /** @@ -1641,9 +1727,9 @@ export namespace bigquery_v2 { * [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query. */ modelOptions?: { + labels?: string[]; lossType?: string; modelType?: string; - labels?: string[]; } | null; /** * [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query. @@ -1694,11 +1780,11 @@ export namespace bigquery_v2 { * Projects to which you have at least READ access. */ projects?: Array<{ + id?: string; + projectReference?: Schema$ProjectReference; friendlyName?: string; numericId?: string; kind?: string; - id?: string; - projectReference?: Schema$ProjectReference; }> | null; /** * The total number of projects in the list. @@ -1883,7 +1969,7 @@ export namespace bigquery_v2 { /** * [TrustedTester] [Required] Defines the ranges for range partitioning. */ - range?: {start?: string; end?: string; interval?: string} | null; + range?: {end?: string; interval?: string; start?: string} | null; } /** * Evaluation metrics for regression and explicit feedback type matrix factorization models. @@ -1986,6 +2072,42 @@ export namespace bigquery_v2 { */ entries?: Schema$Entry[]; } + export interface Schema$ScriptStackFrame { + /** + * [Output-only] One-based end column. + */ + endColumn?: number | null; + /** + * [Output-only] One-based end line. + */ + endLine?: number | null; + /** + * [Output-only] Name of the active procedure, empty if in a top-level script. + */ + procedureId?: string | null; + /** + * [Output-only] One-based start column. + */ + startColumn?: number | null; + /** + * [Output-only] One-based start line. + */ + startLine?: number | null; + /** + * [Output-only] Text of the current statement/expression. + */ + text?: string | null; + } + export interface Schema$ScriptStatistics { + /** + * [Output-only] Whether this child job was a statement or expression. + */ + evaluationKind?: string | null; + /** + * Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty. + */ + stackFrames?: Schema$ScriptStackFrame[]; + } /** * The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"} STRUCT<x STRING, y ARRAY<DATE>>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} */ @@ -2247,17 +2369,18 @@ export namespace bigquery_v2 { * Tables in the requested dataset. */ tables?: Array<{ + creationTime?: string; + rangePartitioning?: Schema$RangePartitioning; + id?: string; tableReference?: Schema$TableReference; - friendlyName?: string; timePartitioning?: Schema$TimePartitioning; - kind?: string; - view?: {useLegacySql?: boolean}; - creationTime?: string; + friendlyName?: string; labels?: {[key: string]: string}; type?: string; clustering?: Schema$Clustering; expirationTime?: string; - id?: string; + kind?: string; + view?: {useLegacySql?: boolean}; }> | null; /** * The total number of tables in the dataset. diff --git a/src/apis/bigqueryconnection/v1beta1.ts b/src/apis/bigqueryconnection/v1beta1.ts index b5097e5e30f..034968787b9 100644 --- a/src/apis/bigqueryconnection/v1beta1.ts +++ b/src/apis/bigqueryconnection/v1beta1.ts @@ -289,7 +289,7 @@ export namespace bigqueryconnection_v1beta1 { nextPageToken?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -297,15 +297,15 @@ export namespace bigqueryconnection_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -374,7 +374,7 @@ export namespace bigqueryconnection_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.connectionId Optional connection id that should be assigned to the created connection. + * @param {string=} params.connectionId Optional. Connection id that should be assigned to the created connection. * @param {string} params.parent Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}` * @param {().Connection} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -667,7 +667,7 @@ export namespace bigqueryconnection_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. + * @param {integer=} params.maxResults Maximum number of results per page. * @param {string=} params.pageToken Page token. * @param {string} params.parent Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -815,7 +815,7 @@ export namespace bigqueryconnection_v1beta1 { /** * bigqueryconnection.projects.locations.connections.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 bigqueryconnection.projects.locations.connections.setIamPolicy * @memberOf! () * @@ -1050,7 +1050,7 @@ export namespace bigqueryconnection_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional connection id that should be assigned to the created connection. + * Optional. Connection id that should be assigned to the created connection. */ connectionId?: string; /** @@ -1112,7 +1112,7 @@ export namespace bigqueryconnection_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Maximum number of results to return. + * Maximum number of results per page. */ maxResults?: number; /** diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index add07f9070c..423181eae82 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -392,11 +392,11 @@ export namespace bigquerydatatransfer_v1 { */ export interface Schema$ScheduleTransferRunsRequest { /** - * End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. + * Required. End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. */ endTime?: string | null; /** - * Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. + * Required. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. */ startTime?: string | null; } @@ -625,7 +625,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` * @param {().CheckValidCredsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -705,7 +705,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_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 @@ -779,7 +779,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` + * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned. Must be in the form: `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 @@ -858,7 +858,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` */ name?: string; @@ -875,7 +875,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` */ name?: string; } @@ -895,7 +895,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` + * Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` */ parent?: string; } @@ -1115,7 +1115,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` * @param {().CheckValidCredsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1195,7 +1195,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_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 @@ -1269,7 +1269,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` + * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned. Must be in the form: `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 @@ -1348,7 +1348,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` + * Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}` */ name?: string; @@ -1365,7 +1365,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}` */ name?: string; } @@ -1385,7 +1385,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` + * Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` */ parent?: string; } @@ -1408,7 +1408,7 @@ export namespace bigquerydatatransfer_v1 { * * @param {object} params Parameters for request * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. - * @param {string} params.parent The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1485,7 +1485,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{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 @@ -1555,7 +1555,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{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 @@ -1630,7 +1630,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.dataSourceIds When specified, only configurations of requested data sources are returned. * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent The BigQuery project id for which data sources should be returned: `projects/{project_id}`. + * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned: `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 @@ -1714,7 +1714,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.name The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. - * @param {string=} params.updateMask Required list of fields to be updated in this request. + * @param {string=} params.updateMask Required. Required list of fields to be updated in this request. * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1788,7 +1788,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. * @param {().ScheduleTransferRunsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1964,7 +1964,7 @@ export namespace bigquerydatatransfer_v1 { */ authorizationCode?: string; /** - * The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. */ parent?: string; /** @@ -1985,7 +1985,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` */ name?: string; } @@ -1997,7 +1997,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` */ name?: string; } @@ -2021,7 +2021,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * The BigQuery project id for which data sources should be returned: `projects/{project_id}`. + * Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`. */ parent?: string; } @@ -2041,7 +2041,7 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; /** - * Required list of fields to be updated in this request. + * Required. Required list of fields to be updated in this request. */ updateMask?: string; /** @@ -2062,7 +2062,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -2106,7 +2106,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_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 @@ -2176,7 +2176,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_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 @@ -2250,7 +2250,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. * @param {string=} params.runAttempt Indicates how run attempts are to be pulled. * @param {string=} params.states When specified, only transfer runs with requested states are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2328,7 +2328,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -2340,7 +2340,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -2360,7 +2360,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. + * Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; /** @@ -2389,7 +2389,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.messageTypes Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * @param {string} params.parent Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_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 @@ -2480,7 +2480,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. */ parent?: string; } @@ -2501,7 +2501,7 @@ export namespace bigquerydatatransfer_v1 { * * @param {object} params Parameters for request * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. - * @param {string} params.parent The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * @param {string} params.parent Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2578,7 +2578,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{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 @@ -2648,7 +2648,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{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 @@ -2723,7 +2723,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.dataSourceIds When specified, only configurations of requested data sources are returned. * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent The BigQuery project id for which data sources should be returned: `projects/{project_id}`. + * @param {string} params.parent Required. The BigQuery project id for which data sources should be returned: `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 @@ -2807,7 +2807,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {string=} params.authorizationCode Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application. * @param {string} params.name The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. - * @param {string=} params.updateMask Required list of fields to be updated in this request. + * @param {string=} params.updateMask Required. Required list of fields to be updated in this request. * @param {string=} params.versionInfo Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request. * @param {().TransferConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2881,7 +2881,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. * @param {().ScheduleTransferRunsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3057,7 +3057,7 @@ export namespace bigquerydatatransfer_v1 { */ authorizationCode?: string; /** - * The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. + * Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail. */ parent?: string; /** @@ -3078,7 +3078,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` */ name?: string; } @@ -3090,7 +3090,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}` */ name?: string; } @@ -3114,7 +3114,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * The BigQuery project id for which data sources should be returned: `projects/{project_id}`. + * Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`. */ parent?: string; } @@ -3134,7 +3134,7 @@ export namespace bigquerydatatransfer_v1 { */ name?: string; /** - * Required list of fields to be updated in this request. + * Required. Required list of fields to be updated in this request. */ updateMask?: string; /** @@ -3155,7 +3155,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. + * Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; @@ -3199,7 +3199,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_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 @@ -3269,7 +3269,7 @@ export namespace bigquerydatatransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * @param {string} params.name Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_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 @@ -3343,7 +3343,7 @@ export namespace bigquerydatatransfer_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. + * @param {string} params.parent Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. * @param {string=} params.runAttempt Indicates how run attempts are to be pulled. * @param {string=} params.states When specified, only transfer runs with requested states are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3421,7 +3421,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -3433,7 +3433,7 @@ export namespace bigquerydatatransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` + * Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` */ name?: string; } @@ -3453,7 +3453,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. + * Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}`. */ parent?: string; /** @@ -3482,7 +3482,7 @@ export namespace bigquerydatatransfer_v1 { * @param {string=} params.messageTypes Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. * @param {integer=} params.pageSize Page size. The default page size is the maximum value of 1000 results. * @param {string=} params.pageToken Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results, `ListTransferLogsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results. - * @param {string} params.parent Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * @param {string} params.parent Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_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 @@ -3573,7 +3573,7 @@ export namespace bigquerydatatransfer_v1 { */ pageToken?: string; /** - * Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. + * Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`. */ parent?: string; } diff --git a/src/apis/bigqueryreservation/index.ts b/src/apis/bigqueryreservation/index.ts index fcb6af9752b..fe8737a64d8 100644 --- a/src/apis/bigqueryreservation/index.ts +++ b/src/apis/bigqueryreservation/index.ts @@ -16,10 +16,12 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {bigqueryreservation_v1} from './v1'; import {bigqueryreservation_v1alpha2} from './v1alpha2'; +import {bigqueryreservation_v1beta1} from './v1beta1'; export const VERSIONS = { v1: bigqueryreservation_v1.Bigqueryreservation, v1alpha2: bigqueryreservation_v1alpha2.Bigqueryreservation, + v1beta1: bigqueryreservation_v1beta1.Bigqueryreservation, }; export function bigqueryreservation( @@ -34,10 +36,17 @@ export function bigqueryreservation( export function bigqueryreservation( options: bigqueryreservation_v1alpha2.Options ): bigqueryreservation_v1alpha2.Bigqueryreservation; +export function bigqueryreservation( + version: 'v1beta1' +): bigqueryreservation_v1beta1.Bigqueryreservation; +export function bigqueryreservation( + options: bigqueryreservation_v1beta1.Options +): bigqueryreservation_v1beta1.Bigqueryreservation; export function bigqueryreservation< T = | bigqueryreservation_v1.Bigqueryreservation | bigqueryreservation_v1alpha2.Bigqueryreservation + | bigqueryreservation_v1beta1.Bigqueryreservation >( this: GoogleConfigurable, versionOrOptions: @@ -45,6 +54,8 @@ export function bigqueryreservation< | bigqueryreservation_v1.Options | 'v1alpha2' | bigqueryreservation_v1alpha2.Options + | 'v1beta1' + | bigqueryreservation_v1beta1.Options ) { return getAPI('bigqueryreservation', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index 4b361960eda..ddb03ac9919 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -118,13 +118,13 @@ export namespace bigqueryreservation_v1 { } /** - * The metadata for operation returned from ReservationService.CreateSlotPool. + * The metadata for operation returned from ReservationService.CreateCapacityCommitment. */ - export interface Schema$CreateSlotPoolMetadata { + export interface Schema$CreateCapacityCommitmentMetadata { /** - * Resource name of the slot pool that is being created. E.g., projects/myproject/locations/us-central1/reservations/foo/slotPools/123 + * Resource name of the capacity commitment that is being created. E.g., projects/myproject/locations/US/capacityCommitments/123 */ - slotPool?: string | null; + capacityCommitment?: 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 `{}`. diff --git a/src/apis/bigqueryreservation/v1alpha2.ts b/src/apis/bigqueryreservation/v1alpha2.ts index 4e44796611e..e89a35176a3 100644 --- a/src/apis/bigqueryreservation/v1alpha2.ts +++ b/src/apis/bigqueryreservation/v1alpha2.ts @@ -130,19 +130,6 @@ export namespace bigqueryreservation_v1alpha2 { * 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 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.ListReservationGrants. */ @@ -182,31 +169,6 @@ export namespace bigqueryreservation_v1alpha2 { */ slotPools?: Schema$SlotPool[]; } - /** - * 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. */ @@ -216,31 +178,6 @@ export namespace bigqueryreservation_v1alpha2 { */ legacyLocationId?: 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; - } /** * A reservation is a mechanism used to guarantee slots to users. */ @@ -317,23 +254,6 @@ export namespace bigqueryreservation_v1alpha2 { */ state?: 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; - } export class Resource$Projects { context: APIRequestContext; @@ -346,14 +266,10 @@ export namespace bigqueryreservation_v1alpha2 { export class Resource$Projects$Locations { context: APIRequestContext; - operations: Resource$Projects$Locations$Operations; reservationGrants: Resource$Projects$Locations$Reservationgrants; reservations: Resource$Projects$Locations$Reservations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); this.reservationGrants = new Resource$Projects$Locations$Reservationgrants( this.context ); @@ -362,156 +278,6 @@ export namespace bigqueryreservation_v1alpha2 { ); } - /** - * 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 + '/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); - } - } - - /** - * 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 + '/v1alpha2/{+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.searchReservationGrants * @desc Look up grants for a specified resource for a particular region. If the request is about a project: 1) Grants created on the project will be returned if they exist. 2) Otherwise grants created on the closest ancestor will be returned. 3) Grants 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 grants created on the organization will be returned (organization doesn't have ancestors). Comparing to ListReservationGrants, there are two behavior differences: 1) permission on the grantee will be verified in this API. 2) Hierarchy lookup (project->folder->organization) happens in this API. @@ -599,42 +365,6 @@ export namespace bigqueryreservation_v1alpha2 { } } - 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 interface Params$Resource$Projects$Locations$Searchreservationgrants extends StandardParameters { /** @@ -660,183 +390,6 @@ export namespace bigqueryreservation_v1alpha2 { query?: string; } - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * bigqueryreservation.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 bigqueryreservation.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://bigqueryreservation.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha2/{+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); - } - } - - /** - * bigqueryreservation.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 bigqueryreservation.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://bigqueryreservation.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); - } - } - } - - 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 class Resource$Projects$Locations$Reservationgrants { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/bigqueryreservation/v1beta1.ts b/src/apis/bigqueryreservation/v1beta1.ts new file mode 100644 index 00000000000..fef5483a5b8 --- /dev/null +++ b/src/apis/bigqueryreservation/v1beta1.ts @@ -0,0 +1,1963 @@ +/** + * 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 bigqueryreservation_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; + } + + /** + * BigQuery Reservation API + * + * A service to modify your BigQuery flat-rate reservations. + * + * @example + * const {google} = require('googleapis'); + * const bigqueryreservation = google.bigqueryreservation('v1beta1'); + * + * @namespace bigqueryreservation + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Bigqueryreservation + */ + export class Bigqueryreservation { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation. + */ + export interface Schema$Assignment { + /** + * The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456. + */ + assignee?: string | null; + /** + * Which type of jobs will use the reservation. + */ + jobType?: string | null; + /** + * Output only. Name of the resource. E.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123. + */ + name?: string | null; + } + /** + * Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some minimum committed period of usage. Capacity commitment is immutable and cannot be deleted until the end of the commitment period. After the end of the commitment period, slots are still available but can be freely removed any time. A capacity commitment resource exists as a child resource of the admin project. + */ + export interface Schema$CapacityCommitment { + /** + * Output only. The end of the commitment period. Capacity commitment cannot be removed before commitment_end_time. It is applicable only for ACTIVE capacity commitments and is computed as a combination of the plan and the time when the capacity commitment became ACTIVE. + */ + commitmentEndTime?: string | null; + /** + * Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 + */ + name?: string | null; + /** + * Capacity commitment commitment plan. + */ + plan?: string | null; + /** + * Number of slots in this commitment. + */ + slotCount?: string | null; + /** + * Output only. State of the commitment. + */ + state?: string | null; + } + /** + * The metadata for operation returned from ReservationService.CreateCapacityCommitment. + */ + export interface Schema$CreateCapacityCommitmentMetadata { + /** + * Resource name of the capacity commitment that is being created. E.g., projects/myproject/locations/US/capacityCommitments/123 + */ + capacityCommitment?: 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 {} + /** + * The response for ReservationService.ListAssignments. + */ + export interface Schema$ListAssignmentsResponse { + /** + * List of assignments visible to the user. + */ + assignments?: Schema$Assignment[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + } + /** + * The response for ReservationService.ListCapacityCommitments. + */ + export interface Schema$ListCapacityCommitmentsResponse { + /** + * List of capacity commitments visible to the user. + */ + capacityCommitments?: Schema$CapacityCommitment[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + 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. + */ + export interface Schema$ListReservationsResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * List of reservations visible to the user. + */ + 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; + } + /** + * 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 reservation is a mechanism used to guarantee slots to users. + */ + export interface Schema$Reservation { + /** + * If true, any query using this reservation might be able to use the idle slots from other reservations within the same admin project. If false, a query using this reservation will execute with the maximum slot capacity as specified above. If not specified, default value is true. + */ + ignoreIdleSlots?: boolean | null; + /** + * The resource name of the reservation, e.g., "projects/x/locations/x/reservations/team1-prod". + */ + 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`. + */ + slotCapacity?: string | null; + } + /** + * The response for ReservationService.SearchAssignments. + */ + export interface Schema$SearchAssignmentsResponse { + /** + * List of assignments visible to the user. + */ + assignments?: Schema$Assignment[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: 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; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + capacityCommitments: Resource$Projects$Locations$Capacitycommitments; + operations: Resource$Projects$Locations$Operations; + reservations: Resource$Projects$Locations$Reservations; + constructor(context: APIRequestContext) { + this.context = context; + this.capacityCommitments = new Resource$Projects$Locations$Capacitycommitments( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.reservations = new Resource$Projects$Locations$Reservations( + this.context + ); + } + + /** + * 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.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. Wildcard "-" can be used for projects in SearchAssignmentsRequest.parent. Note "-" cannot be used for projects nor locations. + * @alias bigqueryreservation.projects.locations.searchAssignments + * @memberOf! () + * + * @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.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. + * @return {object} Request object + */ + searchAssignments( + params?: Params$Resource$Projects$Locations$Searchassignments, + options?: MethodOptions + ): GaxiosPromise; + searchAssignments( + params: Params$Resource$Projects$Locations$Searchassignments, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchAssignments( + params: Params$Resource$Projects$Locations$Searchassignments, + callback: BodyResponseCallback + ): void; + searchAssignments( + callback: BodyResponseCallback + ): void; + searchAssignments( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Searchassignments + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Searchassignments; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Searchassignments; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryreservation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}:searchAssignments').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$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 interface Params$Resource$Projects$Locations$Searchassignments + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of items to return. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The resource name of the admin project(containing project and location), e.g.: "projects/myproject/locations/US". + */ + parent?: string; + /** + * Please specify resource name as assignee in the query. e.g., "assignee=projects/myproject" "assignee=folders/123" "assignee=organizations/456" + */ + query?: string; + } + + export class Resource$Projects$Locations$Capacitycommitments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * bigqueryreservation.projects.locations.capacityCommitments.delete + * @desc Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. + * @alias bigqueryreservation.projects.locations.capacityCommitments.delete + * @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 {object} [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$Capacitycommitments$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Capacitycommitments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Capacitycommitments$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Capacitycommitments$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Capacitycommitments$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Capacitycommitments$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryreservation.projects.locations.capacityCommitments.get + * @desc Returns information about the capacity commitment. + * @alias bigqueryreservation.projects.locations.capacityCommitments.get + * @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 {object} [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$Capacitycommitments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Capacitycommitments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Capacitycommitments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Capacitycommitments$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Capacitycommitments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Capacitycommitments$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.capacityCommitments.list + * @desc Lists all the capacity commitments for the admin project. + * @alias bigqueryreservation.projects.locations.capacityCommitments.list + * @memberOf! () + * + * @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 {object} [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$Capacitycommitments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Capacitycommitments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Capacitycommitments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Capacitycommitments$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Capacitycommitments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Capacitycommitments$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/{+parent}/capacityCommitments').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$Capacitycommitments$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123 + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Capacitycommitments$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name of the capacity commitment to retrieve. E.g., projects/myproject/locations/US/capacityCommitments/123 + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Capacitycommitments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of items to return. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * Resource name of the parent reservation. E.g., projects/myproject/locations/US + */ + parent?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * bigqueryreservation.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 bigqueryreservation.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://bigqueryreservation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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); + } + } + + /** + * bigqueryreservation.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 bigqueryreservation.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://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); + } + } + } + + 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 class Resource$Projects$Locations$Reservations { + context: APIRequestContext; + assignments: Resource$Projects$Locations$Reservations$Assignments; + constructor(context: APIRequestContext) { + this.context = context; + this.assignments = new Resource$Projects$Locations$Reservations$Assignments( + this.context + ); + } + + /** + * bigqueryreservation.projects.locations.reservations.create + * @desc Creates a new reservation resource. + * @alias bigqueryreservation.projects.locations.reservations.create + * @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 alphanumeric characters or dash. + * @param {().Reservation} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Reservations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Reservations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Reservations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryreservation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/reservations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryreservation.projects.locations.reservations.delete + * @desc Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments. This check can be bypassed by setting DeleteReservationRequest.force flag to true. + * @alias bigqueryreservation.projects.locations.reservations.delete + * @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 {object} [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$Reservations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Reservations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Reservations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryreservation.projects.locations.reservations.get + * @desc Returns information about the reservation. + * @alias bigqueryreservation.projects.locations.reservations.get + * @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 {object} [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$Reservations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Reservations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Reservations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$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.reservations.list + * @desc Lists all the reservations for the project in the specified location. + * @alias bigqueryreservation.projects.locations.reservations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @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 {object} [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$Reservations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Reservations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Reservations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$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/{+parent}/reservations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryreservation.projects.locations.reservations.patch + * @desc Updates an existing reservation resource. + * @alias bigqueryreservation.projects.locations.reservations.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the reservation, e.g., "projects/x/locations/x/reservations/team1-prod". + * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. + * @param {().Reservation} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Locations$Reservations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Reservations$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Reservations$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$Patch; + 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: '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$Reservations$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project, location. E.g., projects/myproject/locations/US + */ + parent?: string; + /** + * The reservation ID. This field must only contain alphanumeric characters or dash. + */ + reservationId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Reservation; + } + export interface Params$Resource$Projects$Locations$Reservations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reservations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reservations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * 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). + */ + filter?: string; + /** + * The maximum number of items to return. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The parent resource name containing project and location, e.g.: "projects/myproject/locations/US" + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reservations$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the reservation, e.g., "projects/x/locations/x/reservations/team1-prod". + */ + name?: string; + /** + * Standard field mask for the set of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Reservation; + } + + export class Resource$Projects$Locations$Reservations$Assignments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * bigqueryreservation.projects.locations.reservations.assignments.create + * @desc Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation. + * @alias bigqueryreservation.projects.locations.reservations.assignments.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The parent resource name of the assignment E.g.: projects/myproject/location/US/reservations/team1-prod + * @param {().Assignment} params.resource Request body data + * @param {object} [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$Reservations$Assignments$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Reservations$Assignments$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Reservations$Assignments$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Assignments$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Assignments$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$Assignments$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryreservation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/assignments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryreservation.projects.locations.reservations.assignments.delete + * @desc Deletes a assignment. No expansion will happen. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then deletion of won't affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode. + * @alias bigqueryreservation.projects.locations.reservations.assignments.delete + * @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 {object} [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$Reservations$Assignments$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Reservations$Assignments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Reservations$Assignments$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Assignments$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Assignments$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$Assignments$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryreservation.projects.locations.reservations.assignments.list + * @desc Lists assignments. Only explicitly created assignments will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then this API will just return the above two assignments for reservation res1, and no expansion/merge will happen. Wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. Note "-" cannot be used for projects nor locations. + * @alias bigqueryreservation.projects.locations.reservations.assignments.list + * @memberOf! () + * + * @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/location/US/reservations/team1-prod Or: projects/myproject/location/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 + */ + list( + params?: Params$Resource$Projects$Locations$Reservations$Assignments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Reservations$Assignments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Reservations$Assignments$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Assignments$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Assignments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$Assignments$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/{+parent}/assignments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigqueryreservation.projects.locations.reservations.assignments.move + * @desc Moves a assignment under a new reservation. Customers can do this by deleting the existing assignment followed by creating another assignment under the new reservation, but this method provides a transactional way to do so, to make sure the assignee always has an associated reservation. Without the method customers might see some queries run on-demand which might be unexpected. + * @alias bigqueryreservation.projects.locations.reservations.assignments.move + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.destinationId The new reservation ID, e.g.: projects/myotherproject/locations/US/reservations/team2-prod + * @param {string} params.name The resource name of the assignment, 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 + */ + move( + params?: Params$Resource$Projects$Locations$Reservations$Assignments$Move, + options?: MethodOptions + ): GaxiosPromise; + move( + params: Params$Resource$Projects$Locations$Reservations$Assignments$Move, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + move( + params: Params$Resource$Projects$Locations$Reservations$Assignments$Move, + callback: BodyResponseCallback + ): void; + move(callback: BodyResponseCallback): void; + move( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Assignments$Move + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Assignments$Move; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Reservations$Assignments$Move; + 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}:move').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$Reservations$Assignments$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The parent resource name of the assignment E.g.: projects/myproject/location/US/reservations/team1-prod + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Assignment; + } + export interface Params$Resource$Projects$Locations$Reservations$Assignments$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the resource, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reservations$Assignments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of items to return. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The parent resource name e.g.: projects/myproject/location/US/reservations/team1-prod Or: projects/myproject/location/US/reservations/- + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reservations$Assignments$Move + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The new reservation ID, e.g.: projects/myotherproject/locations/US/reservations/team2-prod + */ + destinationId?: string; + /** + * 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/v1.ts b/src/apis/bigtableadmin/v1.ts index d46e7961604..7ec5177a29c 100644 --- a/src/apis/bigtableadmin/v1.ts +++ b/src/apis/bigtableadmin/v1.ts @@ -199,7 +199,7 @@ export namespace bigtableadmin_v1 { */ export interface Schema$CreateInstanceRequest { /** - * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most two clusters can be specified. + * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most four clusters can be specified. */ clusters?: {[key: string]: Schema$Cluster} | null; /** diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 0c82c1ed8f5..8e410eb588c 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -308,7 +308,7 @@ export namespace bigtableadmin_v2 { */ export interface Schema$CreateInstanceRequest { /** - * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most two clusters can be specified. + * The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. Currently, at most four clusters can be specified. */ clusters?: {[key: string]: Schema$Cluster} | null; /** @@ -653,7 +653,7 @@ export namespace bigtableadmin_v2 { updateMask?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -661,15 +661,15 @@ export namespace bigtableadmin_v2 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } diff --git a/src/apis/binaryauthorization/v1.ts b/src/apis/binaryauthorization/v1.ts index 1c4b480d1e9..e16a5f3cae5 100644 --- a/src/apis/binaryauthorization/v1.ts +++ b/src/apis/binaryauthorization/v1.ts @@ -185,10 +185,65 @@ export namespace binaryauthorization_v1 { */ pkixPublicKey?: Schema$PkixPublicKey; } + /** + * 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`. * `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 an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | 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; + } + /** + * 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). + */ + export interface Schema$IamPolicy { + /** + * 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. + */ + 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?: 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 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. + */ + version?: number | null; + } /** * Response message for BinauthzManagementService.ListAttestors. */ @@ -248,6 +303,33 @@ export namespace binaryauthorization_v1 { */ updateTime?: 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$IamPolicy; + } + /** + * 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; + } /** * An user owned Grafeas note references a Grafeas Attestation.Authority Note created by the user. */ @@ -269,9 +351,11 @@ export namespace binaryauthorization_v1 { export class Resource$Projects { context: APIRequestContext; attestors: Resource$Projects$Attestors; + policy: Resource$Projects$Policy; constructor(context: APIRequestContext) { this.context = context; this.attestors = new Resource$Projects$Attestors(this.context); + this.policy = new Resource$Projects$Policy(this.context); } /** @@ -667,6 +751,82 @@ export namespace binaryauthorization_v1 { } } + /** + * binaryauthorization.projects.attestors.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 binaryauthorization.projects.attestors.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$Attestors$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Attestors$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Attestors$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Attestors$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Attestors$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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); + } + } + /** * binaryauthorization.projects.attestors.list * @desc Lists attestors. Returns INVALID_ARGUMENT if the project does not exist. @@ -746,6 +906,165 @@ export namespace binaryauthorization_v1 { } } + /** + * binaryauthorization.projects.attestors.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 binaryauthorization.projects.attestors.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Attestors$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Attestors$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Attestors$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Attestors$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Attestors$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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); + } + } + + /** + * binaryauthorization.projects.attestors.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 binaryauthorization.projects.attestors.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Attestors$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Attestors$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Attestors$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Attestors$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Attestors$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Attestors$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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); + } + } + /** * binaryauthorization.projects.attestors.update * @desc Updates an attestor. Returns NOT_FOUND if the attestor does not exist. @@ -863,6 +1182,22 @@ export namespace binaryauthorization_v1 { */ name?: string; } + export interface Params$Resource$Projects$Attestors$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$Attestors$List extends StandardParameters { /** @@ -883,6 +1218,40 @@ export namespace binaryauthorization_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Attestors$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$Attestors$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 interface Params$Resource$Projects$Attestors$Update extends StandardParameters { /** @@ -900,4 +1269,297 @@ export namespace binaryauthorization_v1 { */ requestBody?: Schema$Attestor; } + + export class Resource$Projects$Policy { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * binaryauthorization.projects.policy.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 binaryauthorization.projects.policy.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$Policy$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Policy$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Policy$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Policy$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Policy$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Policy$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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); + } + } + + /** + * binaryauthorization.projects.policy.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 binaryauthorization.projects.policy.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Policy$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Policy$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Policy$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Policy$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Policy$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Policy$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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); + } + } + + /** + * binaryauthorization.projects.policy.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 binaryauthorization.projects.policy.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Policy$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Policy$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Policy$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Policy$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Policy$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Policy$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://binaryauthorization.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$Policy$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$Policy$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$Policy$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; + } } diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index 683c4bbd478..b8b5ea02ae2 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -228,19 +228,19 @@ export namespace binaryauthorization_v1beta1 { title?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$IamPolicy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -908,7 +908,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.attestors.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 binaryauthorization.projects.attestors.setIamPolicy * @memberOf! () * @@ -1354,7 +1354,7 @@ export namespace binaryauthorization_v1beta1 { /** * binaryauthorization.projects.policy.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 binaryauthorization.projects.policy.setIamPolicy * @memberOf! () * diff --git a/src/apis/blogger/v3.ts b/src/apis/blogger/v3.ts index 57feafe1838..ca5d301ad70 100644 --- a/src/apis/blogger/v3.ts +++ b/src/apis/blogger/v3.ts @@ -747,7 +747,7 @@ export namespace blogger_v3 { * @param {boolean=} params.fetchUserInfo Whether the response is a list of blogs with per-user information instead of just blogs. * @param {string=} params.role User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles. * @param {string=} params.status Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs. - * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. + * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier. * @param {string=} params.view Access level with which to view the blogs. Note that some fields require elevated access. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -866,7 +866,7 @@ export namespace blogger_v3 { */ status?: string[]; /** - * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. + * ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier. */ userId?: string; /** @@ -890,7 +890,7 @@ export namespace blogger_v3 { * @param {object} params Parameters for request * @param {string} params.blogId The ID of the blog to get. * @param {integer=} params.maxPosts Maximum number of posts to pull back with the blog. - * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. + * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -973,7 +973,7 @@ export namespace blogger_v3 { */ maxPosts?: number; /** - * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. + * ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier. */ userId?: string; } @@ -3608,7 +3608,7 @@ export namespace blogger_v3 { * @param {string} params.blogId The ID of the blog. * @param {integer=} params.maxComments Maximum number of comments to pull back on a post. * @param {string} params.postId The ID of the post to get. - * @param {string} params.userId ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. + * @param {string} params.userId ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3691,7 +3691,7 @@ export namespace blogger_v3 { * @param {string=} params.pageToken Continuation token if the request is paged. * @param {string=} params.startDate Earliest post date to fetch, a date-time with RFC 3339 formatting. * @param {string=} params.status - * @param {string} params.userId ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. + * @param {string} params.userId ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier. * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3779,7 +3779,7 @@ export namespace blogger_v3 { */ postId?: string; /** - * ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. + * ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier. */ userId?: string; } @@ -3827,7 +3827,7 @@ export namespace blogger_v3 { */ status?: string[]; /** - * ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. + * ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier. */ userId?: string; /** diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 244b7d66320..6ba7563b2a4 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -442,7 +442,7 @@ export namespace calendar_v3 { } export interface Schema$ConferenceSolutionKey { /** - * The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) + * The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: - "eventHangout" for Hangouts for consumers (http://hangouts.google.com) - "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com) - "hangoutsMeet" for Hangouts Meet (http://meet.google.com) - "addOn" for 3P conference providers */ type?: string | null; } diff --git a/src/apis/civicinfo/v2.ts b/src/apis/civicinfo/v2.ts index aa783316b5f..bd8345d8d3a 100644 --- a/src/apis/civicinfo/v2.ts +++ b/src/apis/civicinfo/v2.ts @@ -792,8 +792,8 @@ export namespace civicinfo_v2 { published?: boolean | null; schoolDistrict?: string | null; startHouseNumber?: string | null; - startLatE7?: string | null; - startLngE7?: string | null; + startLatE7?: number | null; + startLngE7?: number | null; state?: string | null; stateHouseDistrict?: string | null; stateSenateDistrict?: string | null; diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index 8f2fd30c009..8adf4ea01e8 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -125,6 +125,10 @@ export namespace cloudasset_v1 { export interface Schema$Asset { accessLevel?: Schema$GoogleIdentityAccesscontextmanagerV1AccessLevel; accessPolicy?: Schema$GoogleIdentityAccesscontextmanagerV1AccessPolicy; + /** + * Asset's ancestry path in Cloud Resource Manager (CRM) hierarchy, represented as a list of relative resource names. Ancestry path starts with the closest CRM ancestor and ends at root. If the asset is a CRM project/folder/organization, this starts from the asset itself. Example: ["projects/123456789", "folders/5432", "organizations/1234"] + */ + ancestors?: string[] | null; /** * Type of the asset. Example: "compute.googleapis.com/Disk". */ @@ -221,7 +225,7 @@ export namespace cloudasset_v1 { */ export interface Schema$ExportAssetsRequest { /** - * A list of asset types of which to take a snapshot for. For example: "compute.googleapis.com/Disk". If specified, only matching assets will be returned. 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 asset types of which to take a snapshot for. For example: "compute.googleapis.com/Disk". If specified, only matching assets will be returned. See [Introduction to Cloud Asset Inventory](https://cloud.google.com/asset-inventory/docs/overview) for all supported asset types. */ assetTypes?: string[] | null; /** @@ -281,7 +285,7 @@ export namespace cloudasset_v1 { enforced?: boolean | null; } /** - * Used in `policy_type` to specify how `list_policy` behaves at this resource. `ListPolicy` can define specific values and subtrees of Cloud Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied by setting the `allowed_values` and `denied_values` fields. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - “projects/<project-id>”, e.g. “projects/tokyo-rain-123” - “folders/<folder-id>”, e.g. “folders/1234” - “organizations/<organization-id>”, e.g. “organizations/1234” The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. You can set `allowed_values` and `denied_values` in the same `Policy` if `all_values` is `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset. + * Used in `policy_type` to specify how `list_policy` behaves at this resource. `ListPolicy` can define specific values and subtrees of Cloud Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied by setting the `allowed_values` and `denied_values` fields. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - "projects/<project-id>", e.g. "projects/tokyo-rain-123" - "folders/<folder-id>", e.g. "folders/1234" - "organizations/<organization-id>", e.g. "organizations/1234" The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. You can set `allowed_values` and `denied_values` in the same `Policy` if `all_values` is `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset. */ export interface Schema$GoogleCloudOrgpolicyV1ListPolicy { /** @@ -297,7 +301,7 @@ export namespace cloudasset_v1 { */ deniedValues?: string[] | null; /** - * Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings for `projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a `Policy` with values: {allowed_values: "under:organizations/O1"} `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"} {denied_values: "under:folders/F2"} The accepted values at `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`. + * Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings for `projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values:"E2"} `projects/bar` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values:"E2"} `projects/bar` has a `Policy` with values: {value: "E3" value: "E4" inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values:"E2"} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a `Policy` with values: {allowed_values: "under:organizations/O1"} `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"} {denied_values: "under:folders/F2"} The accepted values at `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`. */ inheritFromParent?: boolean | null; /** @@ -480,7 +484,7 @@ export namespace cloudasset_v1 { */ osType?: string | null; /** - * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request. + * Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request. */ requireVerifiedChromeOs?: boolean | null; } @@ -573,7 +577,7 @@ export namespace cloudasset_v1 { gcsDestination?: Schema$GcsDestination; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -581,15 +585,15 @@ export namespace cloudasset_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -772,8 +776,8 @@ export namespace cloudasset_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.assetNames A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) and [Resource Name Format](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/resource-name-format) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. - * @param {string=} params.contentType Required. The content type. + * @param {string=} params.assetNames A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) and [Resource Name Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. + * @param {string=} params.contentType Optional. The content type. * @param {string} params.parent Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). * @param {string=} params.readTimeWindow.endTime End time of the time window (inclusive). Current timestamp if not specified. * @param {string=} params.readTimeWindow.startTime Start time of the time window (exclusive). @@ -935,11 +939,11 @@ export namespace cloudasset_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) and [Resource Name Format](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/resource-name-format) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. + * A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) and [Resource Name Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. */ assetNames?: string[]; /** - * Required. The content type. + * Optional. The content type. */ contentType?: string; /** diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index f026675deb8..d97fad3a11f 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -284,7 +284,7 @@ export namespace cloudasset_v1beta1 { gcsDestination?: Schema$GcsDestination; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -292,15 +292,15 @@ export namespace cloudasset_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -590,7 +590,7 @@ export namespace cloudasset_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.assetNames A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. - * @param {string=} params.contentType Required. The content type. + * @param {string=} params.contentType Optional. The content type. * @param {string} params.parent Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). * @param {string=} params.readTimeWindow.endTime End time of the time window (inclusive). Current timestamp if not specified. * @param {string=} params.readTimeWindow.startTime Start time of the time window (exclusive). @@ -757,7 +757,7 @@ export namespace cloudasset_v1beta1 { */ assetNames?: string[]; /** - * Required. The content type. + * Optional. The content type. */ contentType?: string; /** @@ -898,7 +898,7 @@ export namespace cloudasset_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.assetNames A list of the full names of the assets. For example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more info. The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request. - * @param {string=} params.contentType Required. The content type. + * @param {string=} params.contentType Optional. The content type. * @param {string} params.parent Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). * @param {string=} params.readTimeWindow.endTime End time of the time window (inclusive). Current timestamp if not specified. * @param {string=} params.readTimeWindow.startTime Start time of the time window (exclusive). @@ -1065,7 +1065,7 @@ export namespace cloudasset_v1beta1 { */ assetNames?: string[]; /** - * Required. The content type. + * Optional. The content type. */ contentType?: string; /** diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index 7d1750e1c8a..cc05760132b 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -153,10 +153,6 @@ export namespace cloudbilling_v1 { * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[] | null; - /** - * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. - */ - ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. */ @@ -312,7 +308,7 @@ export namespace cloudbilling_v1 { units?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -320,15 +316,15 @@ export namespace cloudbilling_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -811,7 +807,7 @@ export namespace cloudbilling_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -1430,7 +1426,7 @@ export namespace cloudbilling_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** diff --git a/src/apis/clouddebugger/v2.ts b/src/apis/clouddebugger/v2.ts index 5f944c4a3ed..97ce0fabab3 100644 --- a/src/apis/clouddebugger/v2.ts +++ b/src/apis/clouddebugger/v2.ts @@ -431,7 +431,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$RegisterDebuggeeRequest { /** - * Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set. + * Required. Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set. */ debuggee?: Schema$Debuggee; } @@ -547,7 +547,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$UpdateActiveBreakpointRequest { /** - * Updated breakpoint information. The field `id` must be set. The agent must echo all Breakpoint specification fields in the update. + * Required. Updated breakpoint information. The field `id` must be set. The agent must echo all Breakpoint specification fields in the update. */ breakpoint?: Schema$Breakpoint; } @@ -803,7 +803,7 @@ export namespace clouddebugger_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.debuggeeId Identifies the debuggee. + * @param {string} params.debuggeeId Required. Identifies the debuggee. * @param {boolean=} params.successOnTimeout If set to `true` (recommended), returns `google.rpc.Code.OK` status and sets the `wait_expired` response field to `true` when the server-selected timeout has expired. If set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status when the server-selected timeout has expired. * @param {string=} params.waitToken A token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server-selected timeout has expired. The value should be set from the `next_wait_token` field in the last response. The initial value should be set to `"init"`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -942,7 +942,7 @@ export namespace clouddebugger_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.debuggeeId Identifies the debuggee being debugged. + * @param {string} params.debuggeeId Required. Identifies the debuggee being debugged. * @param {string} params.id Breakpoint identifier, unique in the scope of the debuggee. * @param {().UpdateActiveBreakpointRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1029,7 +1029,7 @@ export namespace clouddebugger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the debuggee. + * Required. Identifies the debuggee. */ debuggeeId?: string; /** @@ -1049,7 +1049,7 @@ export namespace clouddebugger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Identifies the debuggee being debugged. + * Required. Identifies the debuggee being debugged. */ debuggeeId?: string; /** @@ -1132,9 +1132,9 @@ export namespace clouddebugger_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientVersion The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * @param {string=} params.clientVersion Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). * @param {boolean=} params.includeInactive When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active. - * @param {string=} params.project Project number of a Google Cloud project whose debuggees to list. + * @param {string=} params.project Required. Project number of a Google Cloud project whose debuggees to list. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1213,7 +1213,7 @@ export namespace clouddebugger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** @@ -1221,7 +1221,7 @@ export namespace clouddebugger_v2 { */ includeInactive?: boolean; /** - * Project number of a Google Cloud project whose debuggees to list. + * Required. Project number of a Google Cloud project whose debuggees to list. */ project?: string; } @@ -1285,9 +1285,9 @@ export namespace clouddebugger_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.breakpointId ID of the breakpoint to delete. - * @param {string=} params.clientVersion The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). - * @param {string} params.debuggeeId ID of the debuggee whose breakpoint to delete. + * @param {string} params.breakpointId Required. ID of the breakpoint to delete. + * @param {string=} params.clientVersion Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * @param {string} params.debuggeeId Required. ID of the debuggee whose breakpoint 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 @@ -1409,9 +1409,9 @@ export namespace clouddebugger_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.breakpointId ID of the breakpoint to get. - * @param {string=} params.clientVersion The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). - * @param {string} params.debuggeeId ID of the debuggee whose breakpoint to get. + * @param {string} params.breakpointId Required. ID of the breakpoint to get. + * @param {string=} params.clientVersion Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * @param {string} params.debuggeeId Required. ID of the debuggee whose breakpoint 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 @@ -1535,8 +1535,8 @@ export namespace clouddebugger_v2 { * * @param {object} params Parameters for request * @param {string=} params.action.value Only breakpoints with the specified action will pass the filter. - * @param {string=} params.clientVersion The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). - * @param {string} params.debuggeeId ID of the debuggee whose breakpoints to list. + * @param {string=} params.clientVersion Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * @param {string} params.debuggeeId Required. ID of the debuggee whose breakpoints to list. * @param {boolean=} params.includeAllUsers When set to `true`, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller. * @param {boolean=} params.includeInactive When set to `true`, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints. * @param {boolean=} params.stripResults This field is deprecated. The following fields are always stripped out of the result: `stack_frames`, `evaluated_expressions` and `variable_table`. @@ -1666,8 +1666,8 @@ export namespace clouddebugger_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.clientVersion The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). - * @param {string} params.debuggeeId ID of the debuggee where the breakpoint is to be set. + * @param {string=} params.clientVersion Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * @param {string} params.debuggeeId Required. ID of the debuggee where the breakpoint is to be set. * @param {().Breakpoint} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1746,15 +1746,15 @@ export namespace clouddebugger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the breakpoint to delete. + * Required. ID of the breakpoint to delete. */ breakpointId?: string; /** - * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** - * ID of the debuggee whose breakpoint to delete. + * Required. ID of the debuggee whose breakpoint to delete. */ debuggeeId?: string; } @@ -1766,15 +1766,15 @@ export namespace clouddebugger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the breakpoint to get. + * Required. ID of the breakpoint to get. */ breakpointId?: string; /** - * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** - * ID of the debuggee whose breakpoint to get. + * Required. ID of the debuggee whose breakpoint to get. */ debuggeeId?: string; } @@ -1790,11 +1790,11 @@ export namespace clouddebugger_v2 { */ 'action.value'?: string; /** - * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** - * ID of the debuggee whose breakpoints to list. + * Required. ID of the debuggee whose breakpoints to list. */ debuggeeId?: string; /** @@ -1822,11 +1822,11 @@ export namespace clouddebugger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). + * Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ clientVersion?: string; /** - * ID of the debuggee where the breakpoint is to be set. + * Required. ID of the debuggee where the breakpoint is to be set. */ debuggeeId?: string; diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index ede6e1dad94..7d412618773 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -289,19 +289,19 @@ export namespace clouderrorreporting_v1beta1 { */ export interface Schema$ReportedErrorEvent { /** - * [Optional] A description of the context in which the error occurred. + * Optional. A description of the context in which the error occurred. */ context?: Schema$ErrorContext; /** - * [Optional] Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system will be used. + * Optional. Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system will be used. */ eventTime?: string | null; /** - * [Required] The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` and contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). + * Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` and contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). */ message?: string | null; /** - * [Required] The service context in which this error has occurred. + * Required. The service context in which this error has occurred. */ serviceContext?: Schema$ServiceContext; } @@ -402,7 +402,7 @@ export namespace clouderrorreporting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectName [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-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 @@ -483,7 +483,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; } @@ -501,13 +501,13 @@ export namespace clouderrorreporting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.groupId [Required] The group for which events shall be returned. - * @param {integer=} params.pageSize [Optional] The maximum number of results to return per response. - * @param {string=} params.pageToken [Optional] A `next_page_token` provided by a previous response. - * @param {string} params.projectName [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. - * @param {string=} params.serviceFilter.resourceType [Optional] The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). - * @param {string=} params.serviceFilter.service [Optional] The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). - * @param {string=} params.serviceFilter.version [Optional] The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + * @param {string=} params.groupId Required. The group for which events shall be returned. + * @param {integer=} params.pageSize Optional. The maximum number of results to return per response. + * @param {string=} params.pageToken Optional. A `next_page_token` provided by a previous response. + * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * @param {string=} params.serviceFilter.resourceType Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + * @param {string=} params.serviceFilter.service Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + * @param {string=} params.serviceFilter.version Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). * @param {string=} params.timeRange.period Restricts the query to the specified time range. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -583,7 +583,7 @@ export namespace clouderrorreporting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectName [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. * @param {().ReportedErrorEvent} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -665,31 +665,31 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Required] The group for which events shall be returned. + * Required. The group for which events shall be returned. */ groupId?: string; /** - * [Optional] The maximum number of results to return per response. + * Optional. The maximum number of results to return per response. */ pageSize?: number; /** - * [Optional] A `next_page_token` provided by a previous response. + * Optional. A `next_page_token` provided by a previous response. */ pageToken?: string; /** - * [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; /** - * [Optional] The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + * Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). */ 'serviceFilter.resourceType'?: string; /** - * [Optional] The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + * Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). */ 'serviceFilter.service'?: string; /** - * [Optional] The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + * Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). */ 'serviceFilter.version'?: string; /** @@ -705,7 +705,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/` plus the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. */ projectName?: string; @@ -728,7 +728,7 @@ export namespace clouderrorreporting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.groupName [Required] The group resource name. Written as projects/projectID/groups/group_name. Call groupStats.list to return a list of groups belonging to this project. Example: projects/my-project-123/groups/my-group + * @param {string} params.groupName Required. The group resource name. Written as projects/projectID/groups/group_name. Call groupStats.list to return a list of groups belonging to this project. Example: projects/my-project-123/groups/my-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 @@ -878,7 +878,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Required] The group resource name. Written as projects/projectID/groups/group_name. Call groupStats.list to return a list of groups belonging to this project. Example: projects/my-project-123/groups/my-group + * Required. The group resource name. Written as projects/projectID/groups/group_name. Call groupStats.list to return a list of groups belonging to this project. Example: projects/my-project-123/groups/my-group */ groupName?: string; } @@ -913,17 +913,17 @@ export namespace clouderrorreporting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.alignment [Optional] The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`. - * @param {string=} params.alignmentTime [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC. - * @param {string=} params.groupId [Optional] List all ErrorGroupStats with these IDs. - * @param {string=} params.order [Optional] The sort order in which the results are returned. Default is `COUNT_DESC`. - * @param {integer=} params.pageSize [Optional] The maximum number of results to return per response. Default is 20. - * @param {string=} params.pageToken [Optional] A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. - * @param {string} params.projectName [Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123. - * @param {string=} params.serviceFilter.resourceType [Optional] The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). - * @param {string=} params.serviceFilter.service [Optional] The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). - * @param {string=} params.serviceFilter.version [Optional] The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). - * @param {string=} params.timedCountDuration [Optional] The preferred duration for a single returned `TimedCount`. If not set, no timed counts are returned. + * @param {string=} params.alignment Optional. The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`. + * @param {string=} params.alignmentTime Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC. + * @param {string=} params.groupId Optional. List all ErrorGroupStats with these IDs. + * @param {string=} params.order Optional. The sort order in which the results are returned. Default is `COUNT_DESC`. + * @param {integer=} params.pageSize Optional. The maximum number of results to return per response. Default is 20. + * @param {string=} params.pageToken Optional. A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. + * @param {string} params.projectName Required. The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123. + * @param {string=} params.serviceFilter.resourceType Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + * @param {string=} params.serviceFilter.service Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + * @param {string=} params.serviceFilter.version Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + * @param {string=} params.timedCountDuration Optional. The preferred duration for a single returned `TimedCount`. If not set, no timed counts are returned. * @param {string=} params.timeRange.period Restricts the query to the specified time range. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1003,47 +1003,47 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Optional] The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`. + * Optional. The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`. */ alignment?: string; /** - * [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC. + * Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC. */ alignmentTime?: string; /** - * [Optional] List all ErrorGroupStats with these IDs. + * Optional. List all ErrorGroupStats with these IDs. */ groupId?: string[]; /** - * [Optional] The sort order in which the results are returned. Default is `COUNT_DESC`. + * Optional. The sort order in which the results are returned. Default is `COUNT_DESC`. */ order?: string; /** - * [Optional] The maximum number of results to return per response. Default is 20. + * Optional. The maximum number of results to return per response. Default is 20. */ pageSize?: number; /** - * [Optional] A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. + * Optional. A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. */ pageToken?: string; /** - * [Required] The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123. + * Required. The resource name of the Google Cloud Platform project. Written as projects/ plus the Google Cloud Platform project ID. Example: projects/my-project-123. */ projectName?: string; /** - * [Optional] The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + * Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). */ 'serviceFilter.resourceType'?: string; /** - * [Optional] The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + * Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). */ 'serviceFilter.service'?: string; /** - * [Optional] The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + * Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). */ 'serviceFilter.version'?: string; /** - * [Optional] The preferred duration for a single returned `TimedCount`. If not set, no timed counts are returned. + * Optional. The preferred duration for a single returned `TimedCount`. If not set, no timed counts are returned. */ timedCountDuration?: string; /** diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index f990168d1cb..f25b897970c 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -167,7 +167,7 @@ export namespace cloudfunctions_v1 { */ export interface Schema$CallFunctionRequest { /** - * Input to be passed to the function. + * Required. Input to be passed to the function. */ data?: string | null; } @@ -504,7 +504,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` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -512,15 +512,15 @@ export namespace cloudfunctions_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -674,10 +674,10 @@ export namespace cloudfunctions_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. A filter for matching the requested operations.

              The supported formats of filter are:
              To query for specific function: project:*,location:*,function:*
              To query for all of the latest operations for a project: project:*,latest:true + * @param {string=} params.filter Required. A filter for matching the requested operations.

              The supported formats of filter are:
              To query for a specific function: project:*,location:*,function:*
              To query for all of the latest operations for a project: project:*,latest:true * @param {string=} params.name Must not be set. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. + * @param {integer=} params.pageSize The maximum number of records that should be returned.
              Requested page size cannot exceed 100. If not set, the default page size is 100.

              Pagination is only supported when querying for a specific function. + * @param {string=} params.pageToken Token identifying which result to start with, which is returned by a previous list call.

              Pagination is only supported when querying for a specific function. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -762,7 +762,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A filter for matching the requested operations.

              The supported formats of filter are:
              To query for specific function: project:*,location:*,function:*
              To query for all of the latest operations for a project: project:*,latest:true + * Required. A filter for matching the requested operations.

              The supported formats of filter are:
              To query for a specific function: project:*,location:*,function:*
              To query for all of the latest operations for a project: project:*,latest:true */ filter?: string; /** @@ -770,11 +770,11 @@ export namespace cloudfunctions_v1 { */ name?: string; /** - * The standard list page size. + * The maximum number of records that should be returned.
              Requested page size cannot exceed 100. If not set, the default page size is 100.

              Pagination is only supported when querying for a specific function. */ pageSize?: number; /** - * The standard list page token. + * Token identifying which result to start with, which is returned by a previous list call.

              Pagination is only supported when querying for a specific function. */ pageToken?: string; } @@ -915,7 +915,7 @@ export namespace cloudfunctions_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the function to be called. + * @param {string} params.name Required. The name of the function to be called. * @param {().CallFunctionRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -990,7 +990,7 @@ export namespace cloudfunctions_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.location The project and location in which the function should be created, specified in the format `projects/x/locations/x` + * @param {string} params.location Required. The project and location in which the function should be created, specified in the format `projects/x/locations/x` * @param {().CloudFunction} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1066,7 +1066,7 @@ export namespace cloudfunctions_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the function which should be deleted. + * @param {string} params.name Required. The name of the function which should 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 @@ -1303,7 +1303,7 @@ export namespace cloudfunctions_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the function which details should be obtained. + * @param {string} params.name Required. The name of the function which details should be obtained. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1375,7 +1375,7 @@ export namespace cloudfunctions_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -1761,7 +1761,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the function to be called. + * Required. The name of the function to be called. */ name?: string; @@ -1778,7 +1778,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location in which the function should be created, specified in the format `projects/x/locations/x` + * Required. The project and location in which the function should be created, specified in the format `projects/x/locations/x` */ location?: string; @@ -1795,7 +1795,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the function which should be deleted. + * Required. The name of the function which should be deleted. */ name?: string; } @@ -1841,7 +1841,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the function which details should be obtained. + * Required. The name of the function which details should be obtained. */ name?: string; } @@ -1853,7 +1853,7 @@ export namespace cloudfunctions_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** diff --git a/src/apis/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index 36f5db37b97..a307bc94dbb 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -124,7 +124,7 @@ export namespace cloudfunctions_v1beta2 { */ export interface Schema$CallFunctionRequest { /** - * Input to be passed to the function. + * Required. Input to be passed to the function. */ data?: string | null; } @@ -316,6 +316,10 @@ export namespace cloudfunctions_v1beta2 { * If not empty, indicates that there may be more functions that match the request; this value should be passed in a new google.cloud.functions.v1beta2.ListFunctionsRequest to get more functions. */ nextPageToken?: string | null; + /** + * Locations that could not be reached. The response does not include any functions from these locations. + */ + unreachable?: string[] | null; } /** * The response message for Locations.ListLocations. @@ -578,10 +582,10 @@ export namespace cloudfunctions_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. A filter for matching the requested operations.

              The supported formats of filter are:
              To query for specific function: project:*,location:*,function:*
              To query for all of the latest operations for a project: project:*,latest:true + * @param {string=} params.filter Required. A filter for matching the requested operations.

              The supported formats of filter are:
              To query for a specific function: project:*,location:*,function:*
              To query for all of the latest operations for a project: project:*,latest:true * @param {string=} params.name Must not be set. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. + * @param {integer=} params.pageSize The maximum number of records that should be returned.
              Requested page size cannot exceed 100. If not set, the default page size is 100.

              Pagination is only supported when querying for a specific function. + * @param {string=} params.pageToken Token identifying which result to start with, which is returned by a previous list call.

              Pagination is only supported when querying for a specific function. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -669,7 +673,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A filter for matching the requested operations.

              The supported formats of filter are:
              To query for specific function: project:*,location:*,function:*
              To query for all of the latest operations for a project: project:*,latest:true + * Required. A filter for matching the requested operations.

              The supported formats of filter are:
              To query for a specific function: project:*,location:*,function:*
              To query for all of the latest operations for a project: project:*,latest:true */ filter?: string; /** @@ -677,11 +681,11 @@ export namespace cloudfunctions_v1beta2 { */ name?: string; /** - * The standard list page size. + * The maximum number of records that should be returned.
              Requested page size cannot exceed 100. If not set, the default page size is 100.

              Pagination is only supported when querying for a specific function. */ pageSize?: number; /** - * The standard list page token. + * Token identifying which result to start with, which is returned by a previous list call.

              Pagination is only supported when querying for a specific function. */ pageToken?: string; } @@ -822,7 +826,7 @@ export namespace cloudfunctions_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the function to be called. + * @param {string} params.name Required. The name of the function to be called. * @param {().CallFunctionRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -900,7 +904,7 @@ export namespace cloudfunctions_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.location The project and location in which the function should be created, specified in the format `projects/x/locations/x` + * @param {string} params.location Required. The project and location in which the function should be created, specified in the format `projects/x/locations/x` * @param {().CloudFunction} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -976,7 +980,7 @@ export namespace cloudfunctions_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the function which should be deleted. + * @param {string} params.name Required. The name of the function which should 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 @@ -1213,7 +1217,7 @@ export namespace cloudfunctions_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the function which details should be obtained. + * @param {string} params.name Required. The name of the function which details should be obtained. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1285,7 +1289,7 @@ export namespace cloudfunctions_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.location The project and location from which the function should be listed, specified in the format `projects/x/locations/x` If you want to list functions in all locations, use "-" in place of a location. + * @param {string} params.location Required. The project and location from which the function should be listed, specified in the format `projects/x/locations/x` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations. * @param {integer=} params.pageSize Maximum number of functions to return per call. * @param {string=} params.pageToken The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` 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`. @@ -1364,7 +1368,7 @@ export namespace cloudfunctions_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the function to be updated. + * @param {string} params.name Required. The name of the function to be updated. * @param {().CloudFunction} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1439,7 +1443,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the function to be called. + * Required. The name of the function to be called. */ name?: string; @@ -1456,7 +1460,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location in which the function should be created, specified in the format `projects/x/locations/x` + * Required. The project and location in which the function should be created, specified in the format `projects/x/locations/x` */ location?: string; @@ -1473,7 +1477,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the function which should be deleted. + * Required. The name of the function which should be deleted. */ name?: string; } @@ -1519,7 +1523,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the function which details should be obtained. + * Required. The name of the function which details should be obtained. */ name?: string; } @@ -1531,7 +1535,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location from which the function should be listed, specified in the format `projects/x/locations/x` If you want to list functions in all locations, use "-" in place of a location. + * Required. The project and location from which the function should be listed, specified in the format `projects/x/locations/x` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations. */ location?: string; /** @@ -1551,7 +1555,7 @@ export namespace cloudfunctions_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the function to be updated. + * Required. The name of the function to be updated. */ name?: string; diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 2db1f957774..0c81555b14d 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -135,7 +135,7 @@ export namespace cloudidentity_v1 { */ export interface Schema$Group { /** - * The time when the Group was created. Output only. + * Output only. The time when the Group was created. Output only. */ createTime?: string | null; /** @@ -147,23 +147,23 @@ export namespace cloudidentity_v1 { */ displayName?: string | null; /** - * EntityKey of the Group. Must be set when creating a Group, read-only afterwards. + * Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards. */ groupKey?: Schema$EntityKey; /** - * `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. + * Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. */ labels?: {[key: string]: string} | null; /** - * [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. + * 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. */ name?: string | null; /** - * The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`. + * Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`. */ parent?: string | null; /** - * The time when the Group was last updated. Output only. + * Output only. The time when the Group was last updated. Output only. */ updateTime?: string | null; } @@ -207,15 +207,15 @@ export namespace cloudidentity_v1 { */ export interface Schema$Membership { /** - * Creation timestamp of the Membership. Output only. + * Output only. Creation timestamp of the Membership. Output only. */ createTime?: string | null; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the 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 Must be left blank while creating a Membership. + * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the 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 Must be left blank while creating a Membership. */ name?: string | null; /** - * EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. + * Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. */ preferredMemberKey?: Schema$EntityKey; /** @@ -223,7 +223,7 @@ export namespace cloudidentity_v1 { */ roles?: Schema$MembershipRole[]; /** - * Last updated timestamp of the Membership. Output only. + * Output only. Last updated timestamp of the Membership. Output only. */ updateTime?: string | null; } @@ -665,7 +665,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. Must be left blank while creating a Group. + * @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 {().Group} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -886,7 +886,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. Must be left blank while creating a Group. + * 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. */ name?: string; /** diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index b99dc9bd4fc..36dad843c06 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -139,7 +139,7 @@ export namespace cloudidentity_v1beta1 { */ additionalGroupKeys?: Schema$EntityKey[]; /** - * The time when the Group was created. Output only + * Output only. The time when the Group was created. Output only */ createTime?: string | null; /** @@ -151,23 +151,23 @@ export namespace cloudidentity_v1beta1 { */ displayName?: string | null; /** - * EntityKey of the Group. Must be set when creating a Group, read-only afterwards. + * Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards. */ groupKey?: Schema$EntityKey; /** - * Labels for Group resource. Required. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. + * Required. Labels for Group resource. Required. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. */ labels?: {[key: string]: string} | null; /** - * [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 + * 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 */ name?: string | null; /** - * The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: 'identitysources'. + * Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: 'identitysources'. */ parent?: string | null; /** - * The time when the Group was last updated. Output only + * Output only. The time when the Group was last updated. Output only */ updateTime?: string | null; } @@ -198,23 +198,23 @@ export namespace cloudidentity_v1beta1 { */ export interface Schema$Membership { /** - * Creation timestamp of the Membership. + * Output only. Creation timestamp of the Membership. */ createTime?: string | null; /** - * EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. + * Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`. This field will be deprecated soon. */ memberKey?: Schema$EntityKey; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the 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 Must be left blank while creating a Membership. + * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the 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 Must be left blank while creating a Membership. */ name?: string | null; /** - * Roles for a member within the Group. Currently supported MembershipRoles: `"MEMBER"`. + * Roles for a member within the Group. Currently supported MembershipRoles: `"MEMBER", "OWNER", "MANAGER"`. */ roles?: Schema$MembershipRole[]; /** - * Last updated timestamp of the Membership. + * Output only. Last updated timestamp of the Membership. */ updateTime?: string | null; } @@ -223,7 +223,7 @@ export namespace cloudidentity_v1beta1 { */ export interface Schema$MembershipRole { /** - * MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER"`. + * MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER", "OWNER", "MANAGER"`. */ name?: string | null; } @@ -585,7 +585,7 @@ export namespace cloudidentity_v1beta1 { * @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. Must be left blank while creating a Group + * @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 {().Group} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -786,7 +786,7 @@ export namespace cloudidentity_v1beta1 { 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. Must be left blank while creating a Group + * 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 */ name?: string; /** diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index 47ad32d4d16..333326dd46c 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -122,11 +122,11 @@ export namespace cloudiot_v1 { */ export interface Schema$BindDeviceToGatewayRequest { /** - * The device to associate with the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier. + * Required. The device to associate with the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier. */ deviceId?: string | null; /** - * The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. + * Required. The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. */ gatewayId?: string | null; } @@ -443,7 +443,7 @@ export namespace cloudiot_v1 { */ export interface Schema$ModifyCloudToDeviceConfigRequest { /** - * The configuration data for the device. + * Required. The configuration data for the device. */ binaryData?: string | null; /** @@ -461,19 +461,19 @@ export namespace cloudiot_v1 { mqttEnabledState?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -521,7 +521,7 @@ export namespace cloudiot_v1 { */ export interface Schema$SendCommandToDeviceRequest { /** - * The command data to send to the device. + * Required. The command data to send to the device. */ binaryData?: string | null; /** @@ -591,11 +591,11 @@ export namespace cloudiot_v1 { */ export interface Schema$UnbindDeviceFromGatewayRequest { /** - * The device to disassociate from the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier. + * Required. The device to disassociate from the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier. */ deviceId?: string | null; /** - * The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. + * Required. The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier. */ gatewayId?: string | null; } @@ -674,7 +674,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {string} params.parent Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. * @param {().BindDeviceToGatewayRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -756,7 +756,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`. + * @param {string} params.parent Required. The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`. * @param {().DeviceRegistry} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -831,7 +831,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {string} params.name Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -900,7 +900,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {string} params.name Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1046,7 +1046,7 @@ export namespace cloudiot_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. * @param {string=} params.pageToken The value returned by the last `ListDeviceRegistriesResponse`; indicates that this is a continuation of a prior `ListDeviceRegistries` call and the system should return the next page of data. - * @param {string} params.parent The project and cloud region path. For example, `projects/example-project/locations/us-central1`. + * @param {string} params.parent Required. The project and cloud region path. For example, `projects/example-project/locations/us-central1`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1130,7 +1130,7 @@ export namespace cloudiot_v1 { * * @param {object} params Parameters for request * @param {string} params.name The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. - * @param {string=} params.updateMask Only updates the `device_registry` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `event_notification_config`, `http_config`, `mqtt_config`, and `state_notification_config`. + * @param {string=} params.updateMask Required. Only updates the `device_registry` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `event_notification_config`, `http_config`, `mqtt_config`, and `state_notification_config`. * @param {().DeviceRegistry} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1357,7 +1357,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {string} params.parent Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. * @param {().UnbindDeviceFromGatewayRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1443,7 +1443,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ parent?: string; @@ -1460,7 +1460,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`. + * Required. The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`. */ parent?: string; @@ -1477,7 +1477,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ name?: string; } @@ -1489,7 +1489,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ name?: string; } @@ -1526,7 +1526,7 @@ export namespace cloudiot_v1 { */ pageToken?: string; /** - * The project and cloud region path. For example, `projects/example-project/locations/us-central1`. + * Required. The project and cloud region path. For example, `projects/example-project/locations/us-central1`. */ parent?: string; } @@ -1542,7 +1542,7 @@ export namespace cloudiot_v1 { */ name?: string; /** - * Only updates the `device_registry` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `event_notification_config`, `http_config`, `mqtt_config`, and `state_notification_config`. + * Required. Only updates the `device_registry` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `event_notification_config`, `http_config`, `mqtt_config`, and `state_notification_config`. */ updateMask?: string; @@ -1593,7 +1593,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ parent?: string; @@ -1624,7 +1624,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {string} params.parent Required. The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`. * @param {().Device} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1697,7 +1697,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * @param {string} params.name Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1767,7 +1767,7 @@ export namespace cloudiot_v1 { * * @param {object} params Parameters for request * @param {string=} params.fieldMask The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned. - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * @param {string} params.name Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1844,7 +1844,7 @@ export namespace cloudiot_v1 { * @param {string=} params.gatewayListOptions.gatewayType If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. * @param {integer=} params.pageSize The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. * @param {string=} params.pageToken The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data. - * @param {string} params.parent The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. + * @param {string} params.parent Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1918,7 +1918,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * @param {string} params.name Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. * @param {().ModifyCloudToDeviceConfigRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1996,7 +1996,7 @@ export namespace cloudiot_v1 { * * @param {object} params Parameters for request * @param {string} params.name The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID. - * @param {string=} params.updateMask Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata` + * @param {string=} params.updateMask Required. Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata` * @param {().Device} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2066,7 +2066,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * @param {string} params.name Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. * @param {().SendCommandToDeviceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2150,7 +2150,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * Required. The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`. */ parent?: string; @@ -2167,7 +2167,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; } @@ -2183,7 +2183,7 @@ export namespace cloudiot_v1 { */ fieldMask?: string; /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; } @@ -2227,7 +2227,7 @@ export namespace cloudiot_v1 { */ pageToken?: string; /** - * The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. + * Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. */ parent?: string; } @@ -2239,7 +2239,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; @@ -2260,7 +2260,7 @@ export namespace cloudiot_v1 { */ name?: string; /** - * Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata` + * Required. Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata` */ updateMask?: string; @@ -2277,7 +2277,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; @@ -2300,7 +2300,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * @param {string} params.name Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. * @param {integer=} params.numVersions The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2386,7 +2386,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; /** @@ -2408,7 +2408,7 @@ export namespace cloudiot_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * @param {string} params.name Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. * @param {integer=} params.numStates The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2484,7 +2484,7 @@ export namespace cloudiot_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. + * Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`. */ name?: string; /** @@ -2805,7 +2805,7 @@ export namespace cloudiot_v1 { * @param {string=} params.gatewayListOptions.gatewayType If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. * @param {integer=} params.pageSize The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. * @param {string=} params.pageToken The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data. - * @param {string} params.parent The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. + * @param {string} params.parent Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2913,7 +2913,7 @@ export namespace cloudiot_v1 { */ pageToken?: string; /** - * The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. + * Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. */ parent?: string; } diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 63a17277d72..6ffe0ddece1 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -221,7 +221,7 @@ export namespace cloudkms_v1 { */ primary?: Schema$CryptoKeyVersion; /** - * The immutable purpose of this CryptoKey. + * Immutable. The immutable purpose of this CryptoKey. */ purpose?: string | null; /** @@ -304,7 +304,7 @@ export namespace cloudkms_v1 { */ export interface Schema$DecryptRequest { /** - * Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data. + * Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data. */ additionalAuthenticatedData?: string | null; /** @@ -347,7 +347,7 @@ export namespace cloudkms_v1 { */ export interface Schema$EncryptRequest { /** - * Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. + * Optional. Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. */ additionalAuthenticatedData?: string | null; /** @@ -402,7 +402,7 @@ export namespace cloudkms_v1 { */ importJob?: string | null; /** - * Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: <ol> <li>An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. </li> <li>The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). </li> </ol> This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. + * Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: <ol> <li>An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. </li> <li>The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). </li> </ol> If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. */ rsaAesWrappedKey?: string | null; } @@ -431,7 +431,7 @@ export namespace cloudkms_v1 { */ generateTime?: string | null; /** - * Required and immutable. The wrapping method to be used for incoming key material. + * Required. Immutable. The wrapping method to be used for incoming key material. */ importMethod?: string | null; /** @@ -439,7 +439,7 @@ export namespace cloudkms_v1 { */ name?: string | null; /** - * Required and immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. + * Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. */ protectionLevel?: string | null; /** @@ -593,7 +593,7 @@ export namespace cloudkms_v1 { hsmAvailable?: boolean | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -601,15 +601,15 @@ export namespace cloudkms_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -666,7 +666,7 @@ export namespace cloudkms_v1 { */ export interface Schema$UpdateCryptoKeyPrimaryVersionRequest { /** - * The id of the child CryptoKeyVersion to use as primary. + * Required. The id of the child CryptoKeyVersion to use as primary. */ cryptoKeyVersionId?: string | null; } @@ -978,7 +978,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the KeyRing to get. + * @param {string} params.name Required. The name of the KeyRing 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 @@ -1047,7 +1047,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -1122,8 +1122,8 @@ export namespace cloudkms_v1 { * @param {object} params Parameters for request * @param {string=} params.filter Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). * @param {string=} params.orderBy Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). - * @param {integer=} params.pageSize Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token. + * @param {integer=} params.pageSize Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * @param {string=} params.pageToken Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token. * @param {string} params.parent Required. The resource name of the location associated with the KeyRings, in the format `projects/x/locations/x`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1195,7 +1195,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 cloudkms.projects.locations.keyRings.setIamPolicy * @memberOf! () * @@ -1378,7 +1378,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the KeyRing to get. + * Required. The name of the KeyRing to get. */ name?: string; } @@ -1390,7 +1390,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** @@ -1414,11 +1414,11 @@ export namespace cloudkms_v1 { */ orderBy?: string; /** - * Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token. + * Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token. */ pageToken?: string; /** @@ -1705,7 +1705,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the CryptoKey to get. + * @param {string} params.name Required. The name of the CryptoKey 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 @@ -1776,7 +1776,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -1851,8 +1851,8 @@ export namespace cloudkms_v1 { * @param {object} params Parameters for request * @param {string=} params.filter Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). * @param {string=} params.orderBy Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). - * @param {integer=} params.pageSize Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token. + * @param {integer=} params.pageSize Optional. Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * @param {string=} params.pageToken Optional. Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token. * @param {string} params.parent Required. The resource name of the KeyRing to list, in the format `projects/x/locations/x/keyRings/x`. * @param {string=} params.versionView The fields of the primary version to include in the response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1931,7 +1931,7 @@ export namespace cloudkms_v1 { * * @param {object} params Parameters for request * @param {string} params.name Output only. The resource name for this CryptoKey in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x`. - * @param {string=} params.updateMask Required list of fields to be updated in this request. + * @param {string=} params.updateMask Required. List of fields to be updated in this request. * @param {().CryptoKey} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1998,7 +1998,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy * @memberOf! () * @@ -2158,7 +2158,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the CryptoKey to update. + * @param {string} params.name Required. The resource name of the CryptoKey to update. * @param {().UpdateCryptoKeyPrimaryVersionRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2296,7 +2296,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the CryptoKey to get. + * Required. The name of the CryptoKey to get. */ name?: string; } @@ -2308,7 +2308,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** @@ -2332,11 +2332,11 @@ export namespace cloudkms_v1 { */ orderBy?: string; /** - * Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * Optional. Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token. + * Optional. Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token. */ pageToken?: string; /** @@ -2360,7 +2360,7 @@ export namespace cloudkms_v1 { */ name?: string; /** - * Required list of fields to be updated in this request. + * Required. List of fields to be updated in this request. */ updateMask?: string; @@ -2411,7 +2411,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the CryptoKey to update. + * Required. The resource name of the CryptoKey to update. */ name?: string; @@ -2670,7 +2670,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the CryptoKeyVersion to destroy. + * @param {string} params.name Required. The resource name of the CryptoKeyVersion to destroy. * @param {().DestroyCryptoKeyVersionRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2745,7 +2745,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the CryptoKeyVersion to get. + * @param {string} params.name Required. The name of the CryptoKeyVersion 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 @@ -2816,7 +2816,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the CryptoKeyVersion public key to get. + * @param {string} params.name Required. The name of the CryptoKeyVersion public key 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 @@ -2967,8 +2967,8 @@ export namespace cloudkms_v1 { * @param {object} params Parameters for request * @param {string=} params.filter Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). * @param {string=} params.orderBy Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). - * @param {integer=} params.pageSize Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. + * @param {integer=} params.pageSize Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * @param {string=} params.pageToken Optional. Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. * @param {string} params.parent Required. The resource name of the CryptoKey to list, in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x`. * @param {string=} params.view The fields to include in the response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3054,7 +3054,7 @@ export namespace cloudkms_v1 { * * @param {object} params Parameters for request * @param {string} params.name Output only. The resource name for this CryptoKeyVersion in the format `projects/x/locations/x/keyRings/x/cryptoKeys/x/cryptoKeyVersions/x`. - * @param {string=} params.updateMask Required list of fields to be updated in this request. + * @param {string=} params.updateMask Required. List of fields to be updated in this request. * @param {().CryptoKeyVersion} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3126,7 +3126,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the CryptoKeyVersion to restore. + * @param {string} params.name Required. The resource name of the CryptoKeyVersion to restore. * @param {().RestoreCryptoKeyVersionRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3254,7 +3254,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the CryptoKeyVersion to destroy. + * Required. The resource name of the CryptoKeyVersion to destroy. */ name?: string; @@ -3271,7 +3271,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the CryptoKeyVersion to get. + * Required. The name of the CryptoKeyVersion to get. */ name?: string; } @@ -3283,7 +3283,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the CryptoKeyVersion public key to get. + * Required. The name of the CryptoKeyVersion public key to get. */ name?: string; } @@ -3320,11 +3320,11 @@ export namespace cloudkms_v1 { */ orderBy?: string; /** - * Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. + * Optional. Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. */ pageToken?: string; /** @@ -3348,7 +3348,7 @@ export namespace cloudkms_v1 { */ name?: string; /** - * Required list of fields to be updated in this request. + * Required. List of fields to be updated in this request. */ updateMask?: string; @@ -3365,7 +3365,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the CryptoKeyVersion to restore. + * Required. The resource name of the CryptoKeyVersion to restore. */ name?: string; @@ -3464,7 +3464,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the ImportJob to get. + * @param {string} params.name Required. The name of the ImportJob to get. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3535,7 +3535,7 @@ export namespace cloudkms_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -3610,8 +3610,8 @@ export namespace cloudkms_v1 { * @param {object} params Parameters for request * @param {string=} params.filter Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). * @param {string=} params.orderBy Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering). - * @param {integer=} params.pageSize Optional limit on the number of ImportJobs to include in the response. Further ImportJobs can subsequently be obtained by including the ListImportJobsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. - * @param {string=} params.pageToken Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token. + * @param {integer=} params.pageSize Optional. Optional limit on the number of ImportJobs to include in the response. Further ImportJobs can subsequently be obtained by including the ListImportJobsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * @param {string=} params.pageToken Optional. Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token. * @param {string} params.parent Required. The resource name of the KeyRing to list, in the format `projects/x/locations/x/keyRings/x`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3683,7 +3683,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.importJobs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 cloudkms.projects.locations.keyRings.importJobs.setIamPolicy * @memberOf! () * @@ -3866,7 +3866,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the ImportJob to get. + * Required. The name of the ImportJob to get. */ name?: string; } @@ -3878,7 +3878,7 @@ export namespace cloudkms_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** @@ -3902,11 +3902,11 @@ export namespace cloudkms_v1 { */ orderBy?: string; /** - * Optional limit on the number of ImportJobs to include in the response. Further ImportJobs can subsequently be obtained by including the ListImportJobsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. + * Optional. Optional limit on the number of ImportJobs to include in the response. Further ImportJobs can subsequently be obtained by including the ListImportJobsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. */ pageSize?: number; /** - * Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token. + * Optional. Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token. */ pageToken?: string; /** diff --git a/src/apis/cloudprivatecatalogproducer/v1beta1.ts b/src/apis/cloudprivatecatalogproducer/v1beta1.ts index 3b686b479d4..c6eee35bd0c 100644 --- a/src/apis/cloudprivatecatalogproducer/v1beta1.ts +++ b/src/apis/cloudprivatecatalogproducer/v1beta1.ts @@ -326,7 +326,7 @@ export namespace cloudprivatecatalogproducer_v1beta1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$GoogleIamV1Policy { /** @@ -334,15 +334,15 @@ export namespace cloudprivatecatalogproducer_v1beta1 { */ auditConfigs?: Schema$GoogleIamV1AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ bindings?: Schema$GoogleIamV1Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 1235696233e..d60921c6808 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -448,7 +448,7 @@ export namespace cloudresourcemanager_v1 { policies?: Schema$OrgPolicy[]; } /** - * Used in `policy_type` to specify how `list_policy` behaves at this resource. `ListPolicy` can define specific values and subtrees of Cloud Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied by setting the `allowed_values` and `denied_values` fields. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - “projects/<project-id>”, e.g. “projects/tokyo-rain-123” - “folders/<folder-id>”, e.g. “folders/1234” - “organizations/<organization-id>”, e.g. “organizations/1234” The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. You can set `allowed_values` and `denied_values` in the same `Policy` if `all_values` is `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset. + * Used in `policy_type` to specify how `list_policy` behaves at this resource. `ListPolicy` can define specific values and subtrees of Cloud Resource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or denied by setting the `allowed_values` and `denied_values` fields. This is achieved by using the `under:` and optional `is:` prefixes. The `under:` prefix is used to denote resource subtree values. The `is:` prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - "projects/<project-id>", e.g. "projects/tokyo-rain-123" - "folders/<folder-id>", e.g. "folders/1234" - "organizations/<organization-id>", e.g. "organizations/1234" The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. You can set `allowed_values` and `denied_values` in the same `Policy` if `all_values` is `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` and `denied_values` must be unset. */ export interface Schema$ListPolicy { /** @@ -464,7 +464,7 @@ export namespace cloudresourcemanager_v1 { */ deniedValues?: string[] | null; /** - * Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings for `projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {value: “E3” value: ”E4” inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values:”E2”} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: “E1” allowed_values: ”E2”} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a `Policy` with values: {allowed_values: "under:organizations/O1"} `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"} {denied_values: "under:folders/F2"} The accepted values at `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`. + * Determines the inheritance behavior for this `Policy`. By default, a `ListPolicy` set at a resource supercedes any `Policy` set anywhere up the resource hierarchy. However, if `inherit_from_parent` is set to `true`, then the values from the effective `Policy` of the parent resource are inherited, meaning the values set in this `Policy` are added to the values inherited up the hierarchy. Setting `Policy` hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a `Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` set. In this case, the values that are allowed must be in `allowed_values` and not present in `denied_values`. For example, suppose you have a `Constraint` `constraints/serviceuser.services`, which has a `constraint_type` of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose that at the Organization level, a `Policy` is applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if a `Policy` is applied to a project below the Organization that has `inherit_from_parent` set to `false` and field all_values set to DENY, then an attempt to activate any API will be denied. The following examples demonstrate different possible layerings for `projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values:"E2"} `projects/bar` has `inherit_from_parent` `false` and values: {allowed_values: "E3" allowed_values: "E4"} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values:"E2"} `projects/bar` has a `Policy` with values: {value: "E3" value: "E4" inherit_from_parent: true} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both allowed and denied values): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values: "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values:"E2"} `projects/bar` has a `Policy` with values: {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 (no policy inherits parent policy): `organizations/foo` has no `Policy` set. `projects/bar` has no `Policy` set. The accepted values at both levels are either all or none depending on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` with values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a `Policy` with: {all: DENY} The accepted values at `organizations/foo` are `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a `Policy` with values: {allowed_values: "under:organizations/O1"} `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"} {denied_values: "under:folders/F2"} The accepted values at `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`. */ inheritFromParent?: boolean | null; /** @@ -578,7 +578,7 @@ export namespace cloudresourcemanager_v1 { version?: number | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -586,15 +586,15 @@ export namespace cloudresourcemanager_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -657,7 +657,7 @@ export namespace cloudresourcemanager_v1 { */ id?: string | null; /** - * Required field representing the resource type this id is for. At present, the valid types are: "organization" and "folder". + * Required field representing the resource type this id is for. At present, the valid types are: "organization", "folder", and "project". */ type?: string | null; } diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 4ad1a0dd639..75a93363aaf 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -322,7 +322,7 @@ export namespace cloudresourcemanager_v1beta1 { directoryCustomerId?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -330,15 +330,15 @@ export namespace cloudresourcemanager_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index af24caac7a8..7c31cdfae3b 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -204,7 +204,7 @@ export namespace cloudresourcemanager_v2 { */ name?: string | null; /** - * The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder. + * Required. The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */ parent?: string | null; } @@ -265,7 +265,7 @@ export namespace cloudresourcemanager_v2 { */ folders?: Schema$Folder[]; /** - * A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. This field is optional. + * A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. */ nextPageToken?: string | null; } @@ -274,7 +274,7 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$MoveFolderRequest { /** - * The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + * Required. The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ destinationParent?: string | null; } @@ -304,7 +304,7 @@ export namespace cloudresourcemanager_v2 { response?: {[key: string]: any} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -312,15 +312,15 @@ export namespace cloudresourcemanager_v2 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -346,11 +346,11 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$SearchFoldersRequest { /** - * The maximum number of folders to return in the response. This field is optional. + * Optional. The maximum number of folders to return in the response. */ pageSize?: number | null; /** - * A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. This field is optional. + * Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. */ pageToken?: string | null; /** @@ -367,7 +367,7 @@ export namespace cloudresourcemanager_v2 { */ folders?: Schema$Folder[]; /** - * A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. This field is optional. + * A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. */ nextPageToken?: string | null; } @@ -437,7 +437,7 @@ export namespace cloudresourcemanager_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.parent The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + * @param {string=} params.parent Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. * @param {().Folder} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -509,7 +509,7 @@ export namespace cloudresourcemanager_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. + * @param {string} params.name Required. the resource name of the Folder to be deleted. Must be of the form `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 @@ -578,7 +578,7 @@ export namespace cloudresourcemanager_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. + * @param {string} params.name Required. The resource name of the Folder to retrieve. Must be of the form `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 @@ -721,10 +721,10 @@ export namespace cloudresourcemanager_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of Folders to return in the response. This field is optional. - * @param {string=} params.pageToken A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. This field is optional. - * @param {string=} params.parent The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. - * @param {boolean=} params.showDeleted Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. This field is optional. + * @param {integer=} params.pageSize Optional. The maximum number of Folders to return in the response. + * @param {string=} params.pageToken Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. + * @param {string=} params.parent Required. The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. + * @param {boolean=} params.showDeleted Optional. Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -795,7 +795,7 @@ export namespace cloudresourcemanager_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Folder to move. Must be of the form folders/{folder_id} + * @param {string} params.name Required. The resource name of the Folder to move. Must be of the form folders/{folder_id} * @param {().MoveFolderRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -868,7 +868,7 @@ export namespace cloudresourcemanager_v2 { * * @param {object} params Parameters for request * @param {string} params.name Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". - * @param {string=} params.updateMask Fields to be updated. Only the `display_name` can be updated. + * @param {string=} params.updateMask Required. Fields to be updated. Only the `display_name` can be updated. * @param {().Folder} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1168,7 +1168,7 @@ export namespace cloudresourcemanager_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. + * @param {string} params.name Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. * @param {().UndeleteFolderRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1242,7 +1242,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + * Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ parent?: string; @@ -1258,7 +1258,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. + * Required. the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. */ name?: string; } @@ -1269,7 +1269,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. + * Required. The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. */ name?: string; } @@ -1297,19 +1297,19 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of Folders to return in the response. This field is optional. + * Optional. The maximum number of Folders to return in the response. */ pageSize?: number; /** - * A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. This field is optional. + * Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. */ pageToken?: string; /** - * The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. + * Required. The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. */ parent?: string; /** - * Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. This field is optional. + * Optional. Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. */ showDeleted?: boolean; } @@ -1320,7 +1320,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to move. Must be of the form folders/{folder_id} + * Required. The resource name of the Folder to move. Must be of the form folders/{folder_id} */ name?: string; @@ -1340,7 +1340,7 @@ export namespace cloudresourcemanager_v2 { */ name?: string; /** - * Fields to be updated. Only the `display_name` can be updated. + * Required. Fields to be updated. Only the `display_name` can be updated. */ updateMask?: string; @@ -1401,7 +1401,7 @@ export namespace cloudresourcemanager_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. + * Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. */ name?: string; diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 110cbedbbad..455dcc0c81c 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -204,7 +204,7 @@ export namespace cloudresourcemanager_v2beta1 { */ name?: string | null; /** - * The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder. + * Required. The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */ parent?: string | null; } @@ -265,7 +265,7 @@ export namespace cloudresourcemanager_v2beta1 { */ folders?: Schema$Folder[]; /** - * A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. This field is optional. + * A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. */ nextPageToken?: string | null; } @@ -274,7 +274,7 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$MoveFolderRequest { /** - * The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + * Required. The resource name of the Folder or Organization to reparent the folder under. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ destinationParent?: string | null; } @@ -304,7 +304,7 @@ export namespace cloudresourcemanager_v2beta1 { response?: {[key: string]: any} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -312,15 +312,15 @@ export namespace cloudresourcemanager_v2beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -346,11 +346,11 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$SearchFoldersRequest { /** - * The maximum number of folders to return in the response. This field is optional. + * Optional. The maximum number of folders to return in the response. */ pageSize?: number | null; /** - * A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. This field is optional. + * Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. */ pageToken?: string | null; /** @@ -367,7 +367,7 @@ export namespace cloudresourcemanager_v2beta1 { */ folders?: Schema$Folder[]; /** - * A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. This field is optional. + * A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. */ nextPageToken?: string | null; } @@ -437,7 +437,7 @@ export namespace cloudresourcemanager_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.parent The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + * @param {string=} params.parent Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. * @param {().Folder} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -509,7 +509,7 @@ export namespace cloudresourcemanager_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. + * @param {string} params.name Required. the resource name of the Folder to be deleted. Must be of the form `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 @@ -578,7 +578,7 @@ export namespace cloudresourcemanager_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. + * @param {string} params.name Required. The resource name of the Folder to retrieve. Must be of the form `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 @@ -721,10 +721,10 @@ export namespace cloudresourcemanager_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of Folders to return in the response. This field is optional. - * @param {string=} params.pageToken A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. This field is optional. - * @param {string=} params.parent The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. - * @param {boolean=} params.showDeleted Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. This field is optional. + * @param {integer=} params.pageSize Optional. The maximum number of Folders to return in the response. + * @param {string=} params.pageToken Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. + * @param {string=} params.parent Required. The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. + * @param {boolean=} params.showDeleted Optional. Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -795,7 +795,7 @@ export namespace cloudresourcemanager_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Folder to move. Must be of the form folders/{folder_id} + * @param {string} params.name Required. The resource name of the Folder to move. Must be of the form folders/{folder_id} * @param {().MoveFolderRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -868,7 +868,7 @@ export namespace cloudresourcemanager_v2beta1 { * * @param {object} params Parameters for request * @param {string} params.name Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". - * @param {string=} params.updateMask Fields to be updated. Only the `display_name` can be updated. + * @param {string=} params.updateMask Required. Fields to be updated. Only the `display_name` can be updated. * @param {().Folder} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1168,7 +1168,7 @@ export namespace cloudresourcemanager_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. + * @param {string} params.name Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. * @param {().UndeleteFolderRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1242,7 +1242,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + * Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */ parent?: string; @@ -1258,7 +1258,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. + * Required. the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. */ name?: string; } @@ -1269,7 +1269,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. + * Required. The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. */ name?: string; } @@ -1297,19 +1297,19 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of Folders to return in the response. This field is optional. + * Optional. The maximum number of Folders to return in the response. */ pageSize?: number; /** - * A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. This field is optional. + * Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. */ pageToken?: string; /** - * The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. + * Required. The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`. */ parent?: string; /** - * Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. This field is optional. + * Optional. Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. */ showDeleted?: boolean; } @@ -1320,7 +1320,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to move. Must be of the form folders/{folder_id} + * Required. The resource name of the Folder to move. Must be of the form folders/{folder_id} */ name?: string; @@ -1340,7 +1340,7 @@ export namespace cloudresourcemanager_v2beta1 { */ name?: string; /** - * Fields to be updated. Only the `display_name` can be updated. + * Required. Fields to be updated. Only the `display_name` can be updated. */ updateMask?: string; @@ -1401,7 +1401,7 @@ export namespace cloudresourcemanager_v2beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. + * Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. */ name?: string; diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index fbf524a1cd3..88e8d40ebc8 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -176,6 +176,41 @@ export namespace cloudsearch_v1 { */ itemCountByStatus?: Schema$ItemCountByStatus[]; } + export interface Schema$CustomerQueryStats { + /** + * Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned. + */ + date?: Schema$Date; + queryCountByStatus?: Schema$QueryCountByStatus[]; + } + export interface Schema$CustomerSessionStats { + /** + * Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned. + */ + date?: Schema$Date; + /** + * The count of search sessions on the day + */ + searchSessionsCount?: string | null; + } + export interface Schema$CustomerUserStats { + /** + * Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned. + */ + date?: Schema$Date; + /** + * The count of unique active users in the past one day + */ + oneDayActiveUsersCount?: string | null; + /** + * The count of unique active users in the past seven days + */ + sevenDaysActiveUsersCount?: string | null; + /** + * The count of unique active users in the past thirty days + */ + thirtyDaysActiveUsersCount?: string | null; + } /** * Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. */ @@ -543,12 +578,30 @@ export namespace cloudsearch_v1 { */ stats?: Schema$CustomerIndexStats[]; } + export interface Schema$GetCustomerQueryStatsResponse { + stats?: Schema$CustomerQueryStats[]; + } + export interface Schema$GetCustomerSessionStatsResponse { + stats?: Schema$CustomerSessionStats[]; + } + export interface Schema$GetCustomerUserStatsResponse { + stats?: Schema$CustomerUserStats[]; + } export interface Schema$GetDataSourceIndexStatsResponse { /** * Summary of indexed item counts, one for each day in the requested range. */ stats?: Schema$DataSourceIndexStats[]; } + export interface Schema$GetSearchApplicationQueryStatsResponse { + stats?: Schema$SearchApplicationQueryStats[]; + } + export interface Schema$GetSearchApplicationSessionStatsResponse { + stats?: Schema$SearchApplicationSessionStats[]; + } + export interface Schema$GetSearchApplicationUserStatsResponse { + stats?: Schema$SearchApplicationUserStats[]; + } /** * Gmail Action restricts (i.e. read/replied/snoozed). */ @@ -1312,12 +1365,23 @@ export namespace cloudsearch_v1 { */ item?: Schema$PushItem; } + export interface Schema$QueryCountByStatus { + count?: string | null; + /** + * This represents the http status code. + */ + statusCode?: number | null; + } export interface Schema$QueryInterpretation { interpretationType?: string | null; /** * The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NO_RESULTS_FOUND_FOR_USER_QUERY. */ interpretedQuery?: string | null; + /** + * The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE. + */ + reason?: string | null; } /** * Options to interpret user query. @@ -1327,6 +1391,10 @@ export namespace cloudsearch_v1 { * Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources. */ disableNlInterpretation?: boolean | null; + /** + * Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true. + */ + enableVerbatimMode?: boolean | null; } /** * Information relevant only to a query entry. @@ -1437,7 +1505,7 @@ export namespace cloudsearch_v1 { */ debugOptions?: Schema$DebugOptions; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query. */ languageCode?: string | null; /** @@ -1611,6 +1679,41 @@ export namespace cloudsearch_v1 { */ sourceConfig?: Schema$SourceConfig[]; } + export interface Schema$SearchApplicationQueryStats { + /** + * Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned. + */ + date?: Schema$Date; + queryCountByStatus?: Schema$QueryCountByStatus[]; + } + export interface Schema$SearchApplicationSessionStats { + /** + * Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned. + */ + date?: Schema$Date; + /** + * The count of search sessions on the day + */ + searchSessionsCount?: string | null; + } + export interface Schema$SearchApplicationUserStats { + /** + * Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned. + */ + date?: Schema$Date; + /** + * The count of unique active users in the past one day + */ + oneDayActiveUsersCount?: string | null; + /** + * The count of unique active users in the past seven days + */ + sevenDaysActiveUsersCount?: string | null; + /** + * The count of unique active users in the past thirty days + */ + thirtyDaysActiveUsersCount?: string | null; + } export interface Schema$SearchItemsByViewUrlRequest { /** * Common debug options. @@ -3013,7 +3116,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.delete - * @desc Deletes Item resource for the specified resource name. + * @desc Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.delete * @memberOf! () * @@ -3091,7 +3194,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.deleteQueueItems - * @desc Deletes all items in a queue. This method is useful for deleting stale items. + * @desc Deletes all items in a queue. This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.deleteQueueItems * @memberOf! () * @@ -3165,7 +3268,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.get - * @desc Gets Item resource by item name. + * @desc Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.get * @memberOf! () * @@ -3239,7 +3342,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.index - * @desc Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. + * @desc Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.index * @memberOf! () * @@ -3314,12 +3417,12 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.list - * @desc Lists all or a subset of Item resources. + * @desc Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.list * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.brief When set to true, the indexing system only populates the following fields: name, version, metadata.hash, structured_data.hash, content.hash.
              If this value is false, then all the fields are populated in Item. + * @param {boolean=} params.brief When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type,
              If this value is false, then all the fields are populated in Item. * @param {string=} params.connectorName Name of connector making this call.
              Format: datasources/{source_id}/connectors/{ID} * @param {boolean=} params.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * @param {string} params.name Name of the Data Source to list Items. Format: datasources/{source_id} @@ -3393,7 +3496,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.poll - * @desc Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows:
              ERROR
              MODIFIED
              NEW_ITEM
              ACCEPTED
              Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. + * @desc Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows:
              ERROR
              MODIFIED
              NEW_ITEM
              ACCEPTED
              Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.poll * @memberOf! () * @@ -3468,7 +3571,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.push - * @desc Pushes an item onto a queue for later polling and updating. + * @desc Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.push * @memberOf! () * @@ -3541,7 +3644,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.unreserve - * @desc Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. + * @desc Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.unreserve * @memberOf! () * @@ -3616,7 +3719,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.indexing.datasources.items.upload - * @desc Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. + * @desc Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. * @alias cloudsearch.indexing.datasources.items.upload * @memberOf! () * @@ -3780,7 +3883,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * When set to true, the indexing system only populates the following fields: name, version, metadata.hash, structured_data.hash, content.hash.
              If this value is false, then all the fields are populated in Item. + * When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type,
              If this value is false, then all the fields are populated in Item. */ brief?: boolean; /** @@ -4267,7 +4370,7 @@ export namespace cloudsearch_v1 { * @param {object} params Parameters for request * @param {string=} params.pageToken Number of sources to return in the response. * @param {boolean=} params.requestOptions.debugOptions.enableDebugging If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. - * @param {string=} params.requestOptions.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query. + * @param {string=} params.requestOptions.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query. * @param {string=} params.requestOptions.searchApplicationId Id of the application created using SearchApplicationsService. * @param {string=} params.requestOptions.timeZone Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4352,7 +4455,7 @@ export namespace cloudsearch_v1 { */ 'requestOptions.debugOptions.enableDebugging'?: boolean; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query. */ 'requestOptions.languageCode'?: string; /** @@ -5412,9 +5515,15 @@ export namespace cloudsearch_v1 { export class Resource$Stats { context: APIRequestContext; index: Resource$Stats$Index; + query: Resource$Stats$Query; + session: Resource$Stats$Session; + user: Resource$Stats$User; constructor(context: APIRequestContext) { this.context = context; this.index = new Resource$Stats$Index(this.context); + this.query = new Resource$Stats$Query(this.context); + this.session = new Resource$Stats$Session(this.context); + this.user = new Resource$Stats$User(this.context); } /** @@ -5500,66 +5609,185 @@ export namespace cloudsearch_v1 { ); } } - } - export interface Params$Resource$Stats$Getindex extends StandardParameters { /** - * Auth client or API Key for the request + * cloudsearch.stats.getQuery + * @desc Get the query statistics for customer + * @alias cloudsearch.stats.getQuery + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. + * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. + * @param {object} [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; + getQuery( + params?: Params$Resource$Stats$Getquery, + options?: MethodOptions + ): GaxiosPromise; + getQuery( + params: Params$Resource$Stats$Getquery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getQuery( + params: Params$Resource$Stats$Getquery, + callback: BodyResponseCallback + ): void; + getQuery( + callback: BodyResponseCallback + ): void; + getQuery( + paramsOrCallback?: + | Params$Resource$Stats$Getquery + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Stats$Getquery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Stats$Getquery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/stats/query').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } /** - * Day of month. Must be from 1 to 31 and valid for the year and month. - */ - 'fromDate.day'?: number; - /** - * Month of date. Must be from 1 to 12. - */ - 'fromDate.month'?: number; - /** - * Year of date. Must be from 1 to 9999. - */ - 'fromDate.year'?: number; - /** - * Day of month. Must be from 1 to 31 and valid for the year and month. - */ - 'toDate.day'?: number; - /** - * Month of date. Must be from 1 to 12. - */ - 'toDate.month'?: number; - /** - * Year of date. Must be from 1 to 9999. + * cloudsearch.stats.getSession + * @desc Get the # of search sessions for the customer + * @alias cloudsearch.stats.getSession + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. + * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object */ - 'toDate.year'?: number; - } + getSession( + params?: Params$Resource$Stats$Getsession, + options?: MethodOptions + ): GaxiosPromise; + getSession( + params: Params$Resource$Stats$Getsession, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSession( + params: Params$Resource$Stats$Getsession, + callback: BodyResponseCallback + ): void; + getSession( + callback: BodyResponseCallback + ): void; + getSession( + paramsOrCallback?: + | Params$Resource$Stats$Getsession + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Stats$Getsession; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Stats$Index { - context: APIRequestContext; - datasources: Resource$Stats$Index$Datasources; - constructor(context: APIRequestContext) { - this.context = context; - this.datasources = new Resource$Stats$Index$Datasources(this.context); - } - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Stats$Getsession; + options = {}; + } - export class Resource$Stats$Index$Datasources { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/stats/session').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * cloudsearch.stats.index.datasources.get - * @desc Gets indexed item statistics for a single data source. - * @alias cloudsearch.stats.index.datasources.get + * cloudsearch.stats.getUser + * @desc Get the users statistics for customer + * @alias cloudsearch.stats.getUser * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. - * @param {string} params.name The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}" * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. @@ -5567,40 +5795,39 @@ export namespace cloudsearch_v1 { * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get( - params?: Params$Resource$Stats$Index$Datasources$Get, + getUser( + params?: Params$Resource$Stats$Getuser, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Stats$Index$Datasources$Get, + ): GaxiosPromise; + getUser( + params: Params$Resource$Stats$Getuser, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Stats$Index$Datasources$Get, - callback: BodyResponseCallback + getUser( + params: Params$Resource$Stats$Getuser, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getUser( + callback: BodyResponseCallback ): void; - get( + getUser( paramsOrCallback?: - | Params$Resource$Stats$Index$Datasources$Get - | BodyResponseCallback, + | Params$Resource$Stats$Getuser + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Stats$Index$Datasources$Get; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Stats$Getuser; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Stats$Index$Datasources$Get; + params = {} as Params$Resource$Stats$Getuser; options = {}; } @@ -5613,34 +5840,30 @@ export namespace cloudsearch_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/stats/index/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/stats/user').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Stats$Index$Datasources$Get - extends StandardParameters { + export interface Params$Resource$Stats$Getindex extends StandardParameters { /** * Auth client or API Key for the request */ @@ -5659,7 +5882,694 @@ export namespace cloudsearch_v1 { */ 'fromDate.year'?: number; /** - * The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}" + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } + export interface Params$Resource$Stats$Getquery extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } + export interface Params$Resource$Stats$Getsession extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } + export interface Params$Resource$Stats$Getuser extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } + + export class Resource$Stats$Index { + context: APIRequestContext; + datasources: Resource$Stats$Index$Datasources; + constructor(context: APIRequestContext) { + this.context = context; + this.datasources = new Resource$Stats$Index$Datasources(this.context); + } + } + + export class Resource$Stats$Index$Datasources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * cloudsearch.stats.index.datasources.get + * @desc Gets indexed item statistics for a single data source. + * @alias cloudsearch.stats.index.datasources.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. + * @param {string} params.name The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}" + * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. + * @param {object} [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$Stats$Index$Datasources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Stats$Index$Datasources$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Stats$Index$Datasources$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Stats$Index$Datasources$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Stats$Index$Datasources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Stats$Index$Datasources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/stats/index/{+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$Stats$Index$Datasources$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}" + */ + name?: string; + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } + + export class Resource$Stats$Query { + context: APIRequestContext; + searchapplications: Resource$Stats$Query$Searchapplications; + constructor(context: APIRequestContext) { + this.context = context; + this.searchapplications = new Resource$Stats$Query$Searchapplications( + this.context + ); + } + } + + export class Resource$Stats$Query$Searchapplications { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * cloudsearch.stats.query.searchapplications.get + * @desc Get the query statistics for search application + * @alias cloudsearch.stats.query.searchapplications.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. + * @param {string} params.name The resource id of the search application query stats, in the following format: searchapplications/{application_id} + * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. + * @param {object} [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$Stats$Query$Searchapplications$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Stats$Query$Searchapplications$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GetSearchApplicationQueryStatsResponse + > + ): void; + get( + params: Params$Resource$Stats$Query$Searchapplications$Get, + callback: BodyResponseCallback< + Schema$GetSearchApplicationQueryStatsResponse + > + ): void; + get( + callback: BodyResponseCallback< + Schema$GetSearchApplicationQueryStatsResponse + > + ): void; + get( + paramsOrCallback?: + | Params$Resource$Stats$Query$Searchapplications$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GetSearchApplicationQueryStatsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Stats$Query$Searchapplications$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Stats$Query$Searchapplications$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/stats/query/{+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$Stats$Query$Searchapplications$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * The resource id of the search application query stats, in the following format: searchapplications/{application_id} + */ + name?: string; + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } + + export class Resource$Stats$Session { + context: APIRequestContext; + searchapplications: Resource$Stats$Session$Searchapplications; + constructor(context: APIRequestContext) { + this.context = context; + this.searchapplications = new Resource$Stats$Session$Searchapplications( + this.context + ); + } + } + + export class Resource$Stats$Session$Searchapplications { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * cloudsearch.stats.session.searchapplications.get + * @desc Get the # of search sessions for the search application + * @alias cloudsearch.stats.session.searchapplications.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. + * @param {string} params.name The resource id of the search application session stats, in the following format: searchapplications/{application_id} + * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. + * @param {object} [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$Stats$Session$Searchapplications$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Stats$Session$Searchapplications$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GetSearchApplicationSessionStatsResponse + > + ): void; + get( + params: Params$Resource$Stats$Session$Searchapplications$Get, + callback: BodyResponseCallback< + Schema$GetSearchApplicationSessionStatsResponse + > + ): void; + get( + callback: BodyResponseCallback< + Schema$GetSearchApplicationSessionStatsResponse + > + ): void; + get( + paramsOrCallback?: + | Params$Resource$Stats$Session$Searchapplications$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GetSearchApplicationSessionStatsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Stats$Session$Searchapplications$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Stats$Session$Searchapplications$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/stats/session/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$GetSearchApplicationSessionStatsResponse + >(parameters); + } + } + } + + export interface Params$Resource$Stats$Session$Searchapplications$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * The resource id of the search application session stats, in the following format: searchapplications/{application_id} + */ + name?: string; + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'toDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'toDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'toDate.year'?: number; + } + + export class Resource$Stats$User { + context: APIRequestContext; + searchapplications: Resource$Stats$User$Searchapplications; + constructor(context: APIRequestContext) { + this.context = context; + this.searchapplications = new Resource$Stats$User$Searchapplications( + this.context + ); + } + } + + export class Resource$Stats$User$Searchapplications { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * cloudsearch.stats.user.searchapplications.get + * @desc Get the users statistics for search application + * @alias cloudsearch.stats.user.searchapplications.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. + * @param {string} params.name The resource id of the search application session stats, in the following format: searchapplications/{application_id} + * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. + * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. + * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. + * @param {object} [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$Stats$User$Searchapplications$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Stats$User$Searchapplications$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GetSearchApplicationUserStatsResponse + > + ): void; + get( + params: Params$Resource$Stats$User$Searchapplications$Get, + callback: BodyResponseCallback< + Schema$GetSearchApplicationUserStatsResponse + > + ): void; + get( + callback: BodyResponseCallback< + Schema$GetSearchApplicationUserStatsResponse + > + ): void; + get( + paramsOrCallback?: + | Params$Resource$Stats$User$Searchapplications$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GetSearchApplicationUserStatsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Stats$User$Searchapplications$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Stats$User$Searchapplications$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/stats/user/{+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$Stats$User$Searchapplications$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Day of month. Must be from 1 to 31 and valid for the year and month. + */ + 'fromDate.day'?: number; + /** + * Month of date. Must be from 1 to 12. + */ + 'fromDate.month'?: number; + /** + * Year of date. Must be from 1 to 9999. + */ + 'fromDate.year'?: number; + /** + * The resource id of the search application session stats, in the following format: searchapplications/{application_id} */ name?: string; /** diff --git a/src/apis/cloudshell/v1.ts b/src/apis/cloudshell/v1.ts index 9bd71b6bb66..7e09f189265 100644 --- a/src/apis/cloudshell/v1.ts +++ b/src/apis/cloudshell/v1.ts @@ -134,7 +134,7 @@ export namespace cloudshell_v1 { */ dockerImage?: string | null; /** - * Output only. The environment's identifier, which is always "default". + * Output only. The environment's identifier, unique among the user's environments. */ id?: string | null; /** @@ -145,6 +145,10 @@ export namespace cloudshell_v1 { * Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods. */ publicKeys?: Schema$PublicKey[]; + /** + * Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time. + */ + size?: string | null; /** * Output only. Host to which clients can connect to initiate SSH sessions with the environment. */ @@ -161,10 +165,18 @@ export namespace cloudshell_v1 { * Output only. Current execution state of this environment. */ state?: string | null; + /** + * Output only. The time when the Environment will expire back to the default VM size. + */ + vmSizeExpireTime?: string | null; /** * Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. */ webHost?: string | null; + /** + * Output only. Ports to which clients can connect to initiate HTTPS or WSS connections with the environment. + */ + webPorts?: number[] | null; } /** * The response message for Operations.ListOperations. diff --git a/src/apis/cloudshell/v1alpha1.ts b/src/apis/cloudshell/v1alpha1.ts index 23bb90b8b16..8980f12c0a8 100644 --- a/src/apis/cloudshell/v1alpha1.ts +++ b/src/apis/cloudshell/v1alpha1.ts @@ -156,7 +156,7 @@ export namespace cloudshell_v1alpha1 { */ dockerImage?: string | null; /** - * Output only. The environment's identifier, which is always "default". + * Output only. The environment's identifier, unique among the user's environments. */ id?: string | null; /** @@ -167,6 +167,10 @@ export namespace cloudshell_v1alpha1 { * Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the CreatePublicKey and DeletePublicKey methods. */ publicKeys?: Schema$PublicKey[]; + /** + * Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time. + */ + size?: string | null; /** * Output only. Host to which clients can connect to initiate SSH sessions with the environment. */ @@ -183,10 +187,18 @@ export namespace cloudshell_v1alpha1 { * Output only. Current execution state of this environment. */ state?: string | null; + /** + * Output only. The time when the Environment will expire back to the default VM size. + */ + vmSizeExpireTime?: string | null; /** * Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. */ webHost?: string | null; + /** + * Output only. Ports to which clients can connect to initiate HTTPS or WSS connections with the environment. + */ + webPorts?: number[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 19da417b9d6..7294e729048 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -326,19 +326,19 @@ export namespace cloudtasks_v2 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index b733d9f0d7d..a33442934d3 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -387,19 +387,19 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 7edfe84a084..a214e178e42 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -390,19 +390,19 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$PauseQueueRequest {} /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } diff --git a/src/apis/cloudtrace/v1.ts b/src/apis/cloudtrace/v1.ts index 4887e654cc8..98785a1d7c1 100644 --- a/src/apis/cloudtrace/v1.ts +++ b/src/apis/cloudtrace/v1.ts @@ -181,7 +181,7 @@ export namespace cloudtrace_v1 { */ name?: string | null; /** - * ID of the parent span, if any. Optional. + * Optional. ID of the parent span, if any. */ parentSpanId?: string | null; /** @@ -257,7 +257,7 @@ export namespace cloudtrace_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId ID of the Cloud project where the trace data is stored. + * @param {string} params.projectId Required. ID of the Cloud project where the trace data is stored. * @param {().Traces} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -332,7 +332,7 @@ export namespace cloudtrace_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the Cloud project where the trace data is stored. + * Required. ID of the Cloud project where the trace data is stored. */ projectId?: string; @@ -404,8 +404,8 @@ export namespace cloudtrace_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.projectId ID of the Cloud project where the trace data is stored. - * @param {string} params.traceId ID of the trace to return. + * @param {string} params.projectId Required. ID of the Cloud project where the trace data is stored. + * @param {string} params.traceId Required. ID of the trace 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 @@ -536,13 +536,13 @@ export namespace cloudtrace_v1 { * * @param {object} params Parameters for request * @param {string=} params.endTime End of the time interval (inclusive) during which the trace data was collected from the application. - * @param {string=} params.filter An optional filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (`+`) to the search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns traces whose overall latency is greater than or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with `VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. * `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`. - * @param {string=} params.orderBy Field used to sort the returned traces. Optional. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted. - * @param {integer=} params.pageSize Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional. - * @param {string=} params.pageToken Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. Optional. - * @param {string} params.projectId ID of the Cloud project where the trace data is stored. + * @param {string=} params.filter Optional. A filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (`+`) to the search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns traces whose overall latency is greater than or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with `VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. * `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`. + * @param {string=} params.orderBy Optional. Field used to sort the returned traces. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted. + * @param {integer=} params.pageSize Optional. Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. + * @param {string=} params.pageToken Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. + * @param {string} params.projectId Required. ID of the Cloud project where the trace data is stored. * @param {string=} params.startTime Start of the time interval (inclusive) during which the trace data was collected from the application. - * @param {string=} params.view Type of data returned for traces in the list. Optional. Default is `MINIMAL`. + * @param {string=} params.view Optional. Type of data returned for traces in the list. Default is `MINIMAL`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -618,11 +618,11 @@ export namespace cloudtrace_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the Cloud project where the trace data is stored. + * Required. ID of the Cloud project where the trace data is stored. */ projectId?: string; /** - * ID of the trace to return. + * Required. ID of the trace to return. */ traceId?: string; } @@ -638,23 +638,23 @@ export namespace cloudtrace_v1 { */ endTime?: string; /** - * An optional filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (`+`) to the search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns traces whose overall latency is greater than or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with `VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. * `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`. + * Optional. A filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (`+`) to the search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns traces whose overall latency is greater than or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with `VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. * `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`. */ filter?: string; /** - * Field used to sort the returned traces. Optional. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted. + * Optional. Field used to sort the returned traces. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted. */ orderBy?: string; /** - * Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional. + * Optional. Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. */ pageSize?: number; /** - * Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. Optional. + * Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. */ pageToken?: string; /** - * ID of the Cloud project where the trace data is stored. + * Required. ID of the Cloud project where the trace data is stored. */ projectId?: string; /** @@ -662,7 +662,7 @@ export namespace cloudtrace_v1 { */ startTime?: string; /** - * Type of data returned for traces in the list. Optional. Default is `MINIMAL`. + * Optional. Type of data returned for traces in the list. Default is `MINIMAL`. */ view?: string; } diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 6889fffcc6f..86cfbe25446 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -165,7 +165,7 @@ export namespace cloudtrace_v2 { */ export interface Schema$BatchWriteSpansRequest { /** - * A list of new spans. The span names must not match existing spans, or the results are undefined. + * Required. A list of new spans. The span names must not match existing spans, or the results are undefined. */ spans?: Schema$Span[]; } @@ -250,7 +250,7 @@ export namespace cloudtrace_v2 { */ 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. + * Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. */ childSpanCount?: number | null; /** @@ -274,7 +274,7 @@ export namespace cloudtrace_v2 { */ 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. + * 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; /** @@ -294,7 +294,7 @@ export namespace cloudtrace_v2 { */ startTime?: string | null; /** - * An optional final status for this span. + * Optional. The final status for this span. */ status?: Schema$Status; /** diff --git a/src/apis/commentanalyzer/v1alpha1.ts b/src/apis/commentanalyzer/v1alpha1.ts index 0b7d60b0eb4..8a2e453dfd7 100644 --- a/src/apis/commentanalyzer/v1alpha1.ts +++ b/src/apis/commentanalyzer/v1alpha1.ts @@ -146,7 +146,7 @@ export namespace commentanalyzer_v1alpha1 { */ languages?: string[] | null; /** - * Specification of requested attributes. The AttributeParameters serve as configuration for each associated attribute. The map keys are attribute names. The following attributes are available: "ATTACK_ON_AUTHOR" - Attack on author of original article or post. "ATTACK_ON_COMMENTER" - Attack on fellow commenter. "ATTACK_ON_PUBLISHER" - Attack on publisher of article/post. "INCOHERENT" - Difficult to understand, nonsensical. "INFLAMMATORY" - Intending to provoke or inflame. "OBSCENE" - Obscene, such as cursing. "OFF_TOPIC" - Not related to the original topic. "SPAM" - Commercial/advertising spam content. "UNSUBSTANTIAL" - Trivial. + * Specification of requested attributes. The AttributeParameters serve as configuration for each associated attribute. The map keys are attribute names. The available attributes may be different on each RFE installation, and can be seen by calling ListAttributes (see above). For the prod installation, known as Perspective API, at blade:commentanalyzer-esf and commentanalyzer.googleapis.com, see go/checker-models (internal) and https://github.com/conversationai/perspectiveapi/blob/master/api_reference.md#models. */ requestedAttributes?: {[key: string]: Schema$AttributeParameters} | null; /** diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index d737340951d..fcec03ce8e8 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -836,9 +836,6 @@ export namespace compute_alpha { * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[] | null; - /** - * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. - */ ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. @@ -1301,7 +1298,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * 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 ==) */ export interface Schema$BackendService { /** @@ -1317,7 +1314,7 @@ export namespace compute_alpha { */ cdnPolicy?: Schema$BackendServiceCdnPolicy; /** - * Settings controlling the volume of connections to a backend service. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * Settings controlling the volume of connections to a 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. */ circuitBreakers?: Schema$CircuitBreakers; connectionDraining?: Schema$ConnectionDraining; @@ -1363,7 +1360,7 @@ export namespace compute_alpha { */ kind?: string | null; /** - * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. + * Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer. */ loadBalancingScheme?: string | null; /** @@ -1383,7 +1380,7 @@ export namespace compute_alpha { */ network?: string | null; /** - * Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * 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. */ outlierDetection?: Schema$OutlierDetection; /** @@ -1395,7 +1392,7 @@ export namespace compute_alpha { */ portName?: string | null; /** - * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information. */ protocol?: string | null; /** @@ -1797,11 +1794,11 @@ export namespace compute_alpha { */ export interface Schema$CallCredentials { /** - * The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: ACCESS_TOKEN: An access token is used as call credentials for the SDS server. GCE_VM: The local GCE VM service account credentials are used to access the SDS server. JWT_SERVICE_TOKEN: The user provisioned service account credentials are used to access the SDS server. FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. + * The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. */ callCredentialType?: string | null; /** - * Custom authenticator credentials. + * Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. */ fromPlugin?: Schema$MetadataCredentialsFromPlugin; } @@ -1827,23 +1824,23 @@ export namespace compute_alpha { */ connectTimeout?: Schema$Duration; /** - * The maximum number of connections to the backend cluster. If not specified, the default is 1024. + * The maximum number of connections to the backend service. If not specified, there is no limit. */ maxConnections?: number | null; /** - * The maximum number of pending requests allowed to the backend cluster. If not specified, the default is 1024. + * The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. */ maxPendingRequests?: number | null; /** - * The maximum number of parallel requests that allowed to the backend cluster. If not specified, the default is 1024. + * The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit. */ maxRequests?: number | null; /** - * Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. + * Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. */ maxRequestsPerConnection?: number | null; /** - * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 3. + * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. */ maxRetries?: number | null; } @@ -1872,6 +1869,10 @@ export namespace compute_alpha { * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) */ export interface Schema$Commitment { + /** + * The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. + */ + category?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -1892,6 +1893,10 @@ export namespace compute_alpha { * [Output Only] Type of the resource. Always compute#commitment for commitments. */ kind?: string | null; + /** + * A list of commitment amounts for particular licenses. + */ + licenseResources?: 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. */ @@ -2039,6 +2044,15 @@ export namespace compute_alpha { */ values?: string[] | null; } + /** + * A set of Confidential Instance options. + */ + export interface Schema$ConfidentialInstanceConfig { + /** + * Defines whether the instance should have confidential compute enabled. + */ + enableConfidentialCompute?: boolean | null; + } /** * Message containing connection draining configuration. */ @@ -2127,6 +2141,9 @@ export namespace compute_alpha { * The name of the encryption key that is stored in Google Cloud KMS. */ kmsKeyName?: string | null; + /** + * The service account being used for the encryption request for the given KMS key. If absent, default GCE compute robot account will be used + */ kmsKeyServiceAccount?: string | null; /** * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. @@ -2421,7 +2438,7 @@ export namespace compute_alpha { } export interface Schema$DisksAddResourcePoliciesRequest { /** - * Resource policies to be added to this disk. + * Resource policies to be added to this disk. Currently you can only specify one policy here. */ resourcePolicies?: string[] | null; } @@ -2940,7 +2957,7 @@ export namespace compute_alpha { percent?: number | null; } /** - * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * 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 ==) */ export interface Schema$ForwardingRule { /** @@ -2976,7 +2993,7 @@ export namespace compute_alpha { */ IPAddress?: string | null; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. + * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. */ IPProtocol?: string | null; /** @@ -3000,7 +3017,7 @@ export namespace compute_alpha { */ labels?: {[key: string]: string} | null; /** - * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + * 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; /** @@ -3707,6 +3724,36 @@ export namespace compute_alpha { */ replace?: boolean | null; } + export interface Schema$HTTPHealthCheck { + /** + * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The request path of the HTTP health check request. The default value is /. + */ + requestPath?: string | null; + /** + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + */ + response?: string | null; + } /** * Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. */ @@ -3768,36 +3815,6 @@ export namespace compute_alpha { */ unhealthyThreshold?: number | null; } - export interface Schema$HTTPHealthCheck { - /** - * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. - */ - host?: string | null; - /** - * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. - */ - port?: number | null; - /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. - */ - portName?: string | null; - /** - * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. - */ - portSpecification?: string | null; - /** - * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. - */ - proxyHeader?: string | null; - /** - * The request path of the HTTP health check request. The default value is /. - */ - requestPath?: string | null; - /** - * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. - */ - response?: string | null; - } /** * Contains a list of HttpHealthCheck resources. */ @@ -3886,11 +3903,11 @@ export namespace compute_alpha { */ export interface Schema$HttpRetryPolicy { /** - * Specifies the allowed number retries. This number must be > 0. + * Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. */ numRetries?: number | null; /** - * Specifies a non-zero timeout per retry attempt. + * Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. */ perTryTimeout?: Schema$Duration; /** @@ -3916,7 +3933,7 @@ export namespace compute_alpha { */ retryPolicy?: Schema$HttpRetryPolicy; /** - * Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. + * Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. */ timeout?: Schema$Duration; /** @@ -3932,11 +3949,19 @@ export namespace compute_alpha { * An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. */ export interface Schema$HttpRouteRule { + /** + * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. + */ + description?: string | null; /** * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction */ headerAction?: Schema$HttpHeaderAction; matchRules?: Schema$HttpRouteRuleMatch[]; + /** + * For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules. + */ + priority?: number | null; /** * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. */ @@ -4302,6 +4327,7 @@ export namespace compute_alpha { * Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. */ canIpForward?: boolean | null; + confidentialInstanceConfig?: Schema$ConfidentialInstanceConfig; /** * [Output Only] The CPU platform used by this instance. */ @@ -4378,6 +4404,10 @@ export namespace compute_alpha { * An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. */ networkInterfaces?: Schema$NetworkInterface[]; + /** + * Specifies whether this instance will be shut down on key revocation. + */ + postKeyRevocationActionType?: string | null; /** * Total amount of preserved state for SUSPENDED instances. Read-only in the api. */ @@ -4881,10 +4911,6 @@ export namespace compute_alpha { * InstanceGroupManagers.deletePerInstanceConfigs */ export interface Schema$InstanceGroupManagersDeletePerInstanceConfigsReq { - /** - * The list of instances for which we want to delete per-instance configs on this managed instance group. - */ - instances?: string[] | null; /** * The list of instance names for which we want to delete per-instance configs on this managed instance group. */ @@ -4987,6 +5013,10 @@ export namespace compute_alpha { 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. */ @@ -5260,6 +5290,10 @@ export namespace compute_alpha { * Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. */ canIpForward?: boolean | null; + /** + * Specifies the Confidential Instance options. + */ + confidentialInstanceConfig?: Schema$ConfidentialInstanceConfig; /** * An optional text description for the instances that are created from this instance template. */ @@ -5296,6 +5330,10 @@ export namespace compute_alpha { * An array of network access configurations for this interface. */ networkInterfaces?: Schema$NetworkInterface[]; + /** + * Specifies whether this instance will be shut down on key revocation. + */ + postKeyRevocationActionType?: string | null; /** * Specifies the reservations that this instance can consume from. */ @@ -6388,6 +6426,23 @@ export namespace compute_alpha { */ selfLink?: string | null; } + /** + * Commitment for a particular license resource (a License Commitment is composed of one or more of these). + */ + export interface Schema$LicenseResourceCommitment { + /** + * The number of licenses purchased. + */ + amount?: string | null; + /** + * Specifies the core range of the instance for which this license applies. + */ + coresPerLicense?: string | null; + /** + * Any applicable license URI. + */ + license?: string | null; + } export interface Schema$LicenseResourceRequirements { /** * Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. @@ -6469,9 +6524,13 @@ export namespace compute_alpha { logName?: 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/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). + * 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]} TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields in the same counter. */ export interface Schema$LogConfigCounterOptions { + /** + * Custom fields. + */ + customFields?: Schema$LogConfigCounterOptionsCustomField[]; /** * The field value to attribute. */ @@ -6481,6 +6540,19 @@ export namespace compute_alpha { */ 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$LogConfigCounterOptionsCustomField { + /** + * 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 */ @@ -6992,6 +7064,18 @@ export namespace compute_alpha { * Metadata defined as annotations on the network endpoint group. */ annotations?: {[key: string]: string} | null; + /** + * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. + */ + appEngine?: Schema$NetworkEndpointGroupAppEngine; + /** + * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. + */ + cloudFunction?: Schema$NetworkEndpointGroupCloudFunction; + /** + * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. + */ + cloudRun?: Schema$NetworkEndpointGroupCloudRun; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -7028,6 +7112,10 @@ export namespace compute_alpha { * Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT. */ networkEndpointType?: string | null; + /** + * [Output Only] The URL of the region where the network endpoint group is located. + */ + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ @@ -7083,6 +7171,53 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. + */ + export interface Schema$NetworkEndpointGroupAppEngine { + /** + * Optional serving service. The service name must be 1-63 characters long, and comply with RFC1035. Example value: "default", "my-service". + */ + service?: string | null; + /** + * A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. + */ + urlMask?: string | null; + /** + * Optional serving version. The version must be 1-63 characters long, and comply with RFC1035. Example value: "v1", "v2". + */ + version?: string | null; + } + /** + * Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. + */ + 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". + */ + function?: string | null; + /** + * A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs "mydomain.com/function1" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. + */ + urlMask?: string | null; + } + /** + * Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. + */ + 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". + */ + service?: string | null; + /** + * Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "revision-0010". + */ + tag?: string | null; + /** + * A template to parse service and tag fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively. + */ + urlMask?: string | null; + } /** * Load balancing specific fields for network endpoint group. */ @@ -7540,6 +7675,10 @@ export namespace compute_alpha { * Binding properties for the physical server. */ serverBinding?: Schema$ServerBinding; + /** + * Server ID associated with this node. + */ + serverId?: string | null; status?: string | null; } export interface Schema$NodeGroupsAddNodesRequest { @@ -7938,6 +8077,10 @@ export namespace compute_alpha { * 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. */ @@ -8174,11 +8317,11 @@ export namespace compute_alpha { jwt?: Schema$Jwt; } /** - * Settings controlling eviction of unhealthy hosts from the load balancing pool. + * Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. */ export interface Schema$OutlierDetection { /** - * The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + * The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. */ baseEjectionTime?: Schema$Duration; /** @@ -8186,15 +8329,15 @@ export namespace compute_alpha { */ consecutiveErrors?: number | null; /** - * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5. + * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. */ consecutiveGatewayFailure?: number | null; /** - * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. */ enforcingConsecutiveErrors?: number | null; /** - * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. */ enforcingConsecutiveGatewayFailure?: number | null; /** @@ -8202,11 +8345,11 @@ export namespace compute_alpha { */ enforcingSuccessRate?: number | null; /** - * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds. + * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 seconds. */ interval?: Schema$Duration; /** - * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%. + * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. */ maxEjectionPercent?: number | null; /** @@ -8288,7 +8431,7 @@ export namespace compute_alpha { */ kind?: string | null; /** - * PacketMirroring mirroredResourceInfos. Each mirroredResourceInfo specifies a set of mirrored VM instances and/or a set of subnetworks for which traffic from/to all VM instances will be mirrored. + * 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; /** @@ -8424,7 +8567,7 @@ export namespace compute_alpha { */ instances?: Schema$PacketMirroringMirroredResourceInfoInstanceInfo[]; /** - * A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in zones contained in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks. + * 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[]; /** @@ -8511,11 +8654,11 @@ export namespace compute_alpha { */ name?: string | null; /** - * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. + * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. */ pathRules?: Schema$PathRule[]; /** - * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Only one of pathRules or routeRules must be set. + * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. */ routeRules?: Schema$HttpRouteRule[]; } @@ -8618,7 +8761,7 @@ export namespace compute_alpha { values?: string[] | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -8626,11 +8769,11 @@ export namespace compute_alpha { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; iamOwned?: boolean | null; @@ -8639,7 +8782,7 @@ export namespace compute_alpha { */ rules?: Schema$Rule[]; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -8942,10 +9085,6 @@ export namespace compute_alpha { * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. */ fingerprint?: string | null; - /** - * The list of Google announcements that exist for this delegated prefix. - */ - googleAnnouncements?: Schema$PublicDelegatedPrefixGoogleAnnouncement[]; /** * [Output Only] The unique identifier for the resource type. The server generates this identifier. */ @@ -9031,19 +9170,6 @@ export namespace compute_alpha { message?: string; } | null; } - /** - * A Google announcement advertises the prefix internally within Google's network backbone from the specified scope. - */ - export interface Schema$PublicDelegatedPrefixGoogleAnnouncement { - /** - * The name of a Google announcement. 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 status of this Google announcement. - */ - status?: string | null; - } export interface Schema$PublicDelegatedPrefixList { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -9336,10 +9462,6 @@ export namespace compute_alpha { * RegionInstanceGroupManagers.deletePerInstanceConfigs */ export interface Schema$RegionInstanceGroupManagerDeleteInstanceConfigReq { - /** - * The list of instances for which we want to delete per-instance configs on this managed instance group. - */ - instances?: string[] | null; /** * The list of instance names for which we want to delete per-instance configs on this managed instance group. */ @@ -9918,6 +10040,14 @@ export namespace compute_alpha { * 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; + /** + * Distribution specifies how the instances are placed at host level. If set to SPREAD, no two instances will be put on the same host + */ + distribution?: string | null; /** * Specifies network locality */ @@ -10117,7 +10247,7 @@ export namespace compute_alpha { */ nextHopGateway?: string | null; /** - * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule Note that this can only be used when the destination_range is a public (non-RFC 1918) IP CIDR range. + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule */ nextHopIlb?: string | null; /** @@ -10778,6 +10908,10 @@ export namespace compute_alpha { * Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set. */ latencyTolerant?: boolean | null; + /** + * An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API. + */ + locationHint?: string | null; /** * The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. */ @@ -12217,7 +12351,7 @@ export namespace compute_alpha { */ proxyBind?: boolean | null; /** - * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. + * Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. - */ quicOverride?: string | null; /** @@ -12237,7 +12371,7 @@ export namespace compute_alpha { */ sslCertificates?: string[] | null; /** - * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. + * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. */ sslPolicy?: string | null; /** @@ -13676,7 +13810,7 @@ export namespace compute_alpha { */ sharedSecretHash?: string | null; /** - * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. + * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being blacklisted. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. */ status?: string | null; /** @@ -13960,7 +14094,7 @@ export namespace compute_alpha { /** * compute.acceleratorTypes.aggregatedList - * @desc Retrieves an aggregated list of accelerator types. + * @desc Retrieves an aggregated list of accelerator types. (== suppress_warning http-rest-shadowed ==) * @alias compute.acceleratorTypes.aggregatedList * @memberOf! () * @@ -14047,7 +14181,7 @@ export namespace compute_alpha { /** * compute.acceleratorTypes.get - * @desc Returns the specified accelerator type. + * @desc Returns the specified accelerator type. (== suppress_warning http-rest-shadowed ==) * @alias compute.acceleratorTypes.get * @memberOf! () * @@ -14123,7 +14257,7 @@ export namespace compute_alpha { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified project. + * @desc Retrieves a list of accelerator types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.acceleratorTypes.list * @memberOf! () * @@ -14290,7 +14424,7 @@ export namespace compute_alpha { /** * compute.addresses.aggregatedList - * @desc Retrieves an aggregated list of addresses. + * @desc Retrieves an aggregated list of addresses. (== suppress_warning http-rest-shadowed ==) * @alias compute.addresses.aggregatedList * @memberOf! () * @@ -14371,7 +14505,7 @@ export namespace compute_alpha { /** * compute.addresses.delete - * @desc Deletes the specified address resource. + * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.addresses.delete * @memberOf! () * @@ -14447,7 +14581,7 @@ export namespace compute_alpha { /** * compute.addresses.get - * @desc Returns the specified address resource. + * @desc Returns the specified address resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.addresses.get * @memberOf! () * @@ -14520,7 +14654,7 @@ export namespace compute_alpha { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.addresses.insert * @memberOf! () * @@ -14596,7 +14730,7 @@ export namespace compute_alpha { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified region. + * @desc Retrieves a list of addresses contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.addresses.list * @memberOf! () * @@ -14674,7 +14808,7 @@ export namespace compute_alpha { /** * compute.addresses.setLabels - * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.addresses.setLabels * @memberOf! () * @@ -14752,7 +14886,7 @@ export namespace compute_alpha { /** * compute.addresses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.addresses.testIamPermissions * @memberOf! () * @@ -15020,7 +15154,7 @@ export namespace compute_alpha { /** * compute.autoscalers.aggregatedList - * @desc Retrieves an aggregated list of autoscalers. + * @desc Retrieves an aggregated list of autoscalers. (== suppress_warning http-rest-shadowed ==) * @alias compute.autoscalers.aggregatedList * @memberOf! () * @@ -15102,7 +15236,7 @@ export namespace compute_alpha { /** * compute.autoscalers.delete - * @desc Deletes the specified autoscaler. + * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @alias compute.autoscalers.delete * @memberOf! () * @@ -15179,7 +15313,7 @@ export namespace compute_alpha { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.autoscalers.get * @memberOf! () * @@ -15254,7 +15388,7 @@ export namespace compute_alpha { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.autoscalers.insert * @memberOf! () * @@ -15331,7 +15465,7 @@ export namespace compute_alpha { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified zone. + * @desc Retrieves a list of autoscalers contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.autoscalers.list * @memberOf! () * @@ -15409,7 +15543,7 @@ export namespace compute_alpha { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.autoscalers.patch * @memberOf! () * @@ -15487,7 +15621,7 @@ export namespace compute_alpha { /** * compute.autoscalers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.autoscalers.testIamPermissions * @memberOf! () * @@ -15568,7 +15702,7 @@ export namespace compute_alpha { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.autoscalers.update * @memberOf! () * @@ -15864,7 +15998,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend bucket. + * @desc Adds a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -15941,7 +16075,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.delete - * @desc Deletes the specified BackendBucket resource. + * @desc Deletes the specified BackendBucket resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.delete * @memberOf! () * @@ -16017,7 +16151,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend bucket. + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -16094,7 +16228,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.get * @memberOf! () * @@ -16169,7 +16303,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.getIamPolicy * @memberOf! () * @@ -16243,7 +16377,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the data included in the request. + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.insert * @memberOf! () * @@ -16319,7 +16453,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the specified project. + * @desc Retrieves the list of BackendBucket resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.list * @memberOf! () * @@ -16397,7 +16531,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.patch * @memberOf! () * @@ -16474,7 +16608,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.setIamPolicy * @memberOf! () * @@ -16548,7 +16682,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.testIamPermissions * @memberOf! () * @@ -16628,7 +16762,7 @@ export namespace compute_alpha { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included in the request. + * @desc Updates the specified BackendBucket resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.update * @memberOf! () * @@ -16959,7 +17093,7 @@ export namespace compute_alpha { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend service. + * @desc Adds a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -17036,7 +17170,7 @@ export namespace compute_alpha { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.aggregatedList * @memberOf! () * @@ -17123,7 +17257,7 @@ export namespace compute_alpha { /** * compute.backendServices.delete - * @desc Deletes the specified BackendService resource. + * @desc Deletes the specified BackendService resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.delete * @memberOf! () * @@ -17199,7 +17333,7 @@ export namespace compute_alpha { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend service. + * @desc Deletes a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -17276,7 +17410,7 @@ export namespace compute_alpha { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of available backend services. + * @desc Returns the specified BackendService resource. Gets a list of available backend services. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.get * @memberOf! () * @@ -17351,7 +17485,7 @@ export namespace compute_alpha { /** * compute.backendServices.getHealth - * @desc Gets the most recent health check results for this BackendService. + * @desc Gets the most recent health check results for this BackendService. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.getHealth * @memberOf! () * @@ -17434,7 +17568,7 @@ export namespace compute_alpha { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.insert * @memberOf! () * @@ -17510,7 +17644,7 @@ export namespace compute_alpha { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the specified project. + * @desc Retrieves the list of BackendService resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.list * @memberOf! () * @@ -17588,7 +17722,7 @@ export namespace compute_alpha { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.patch * @memberOf! () * @@ -17665,7 +17799,7 @@ export namespace compute_alpha { /** * compute.backendServices.setSecurityPolicy - * @desc Sets the security policy for the specified backend service. + * @desc Sets the security policy for the specified backend service. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.setSecurityPolicy * @memberOf! () * @@ -17742,7 +17876,7 @@ export namespace compute_alpha { /** * compute.backendServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.testIamPermissions * @memberOf! () * @@ -17822,7 +17956,7 @@ export namespace compute_alpha { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.update * @memberOf! () * @@ -18186,7 +18320,7 @@ export namespace compute_alpha { /** * compute.disks.addResourcePolicies - * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.addResourcePolicies * @memberOf! () * @@ -18264,7 +18398,7 @@ export namespace compute_alpha { /** * compute.disks.aggregatedList - * @desc Retrieves an aggregated list of persistent disks. + * @desc Retrieves an aggregated list of persistent disks. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.aggregatedList * @memberOf! () * @@ -18343,7 +18477,7 @@ export namespace compute_alpha { /** * compute.disks.createSnapshot - * @desc Creates a snapshot of a specified persistent disk. + * @desc Creates a snapshot of a specified persistent disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.createSnapshot * @memberOf! () * @@ -18422,7 +18556,7 @@ export namespace compute_alpha { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.delete * @memberOf! () * @@ -18498,7 +18632,7 @@ export namespace compute_alpha { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.get * @memberOf! () * @@ -18571,7 +18705,7 @@ export namespace compute_alpha { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -18646,7 +18780,7 @@ export namespace compute_alpha { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.insert * @memberOf! () * @@ -18722,7 +18856,7 @@ export namespace compute_alpha { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified zone. + * @desc Retrieves a list of persistent disks contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.list * @memberOf! () * @@ -18797,7 +18931,7 @@ export namespace compute_alpha { /** * compute.disks.removeResourcePolicies - * @desc Removes resource policies from a disk. + * @desc Removes resource policies from a disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.removeResourcePolicies * @memberOf! () * @@ -18877,7 +19011,7 @@ export namespace compute_alpha { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the size of the disk. + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.resize * @memberOf! () * @@ -18954,7 +19088,7 @@ export namespace compute_alpha { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -19029,7 +19163,7 @@ export namespace compute_alpha { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.setLabels * @memberOf! () * @@ -19106,7 +19240,7 @@ export namespace compute_alpha { /** * compute.disks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.testIamPermissions * @memberOf! () * @@ -19545,7 +19679,7 @@ export namespace compute_alpha { /** * compute.diskTypes.aggregatedList - * @desc Retrieves an aggregated list of disk types. + * @desc Retrieves an aggregated list of disk types. (== suppress_warning http-rest-shadowed ==) * @alias compute.diskTypes.aggregatedList * @memberOf! () * @@ -19626,7 +19760,7 @@ export namespace compute_alpha { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.diskTypes.get * @memberOf! () * @@ -19699,7 +19833,7 @@ export namespace compute_alpha { /** * compute.diskTypes.list - * @desc Retrieves a list of disk types available to the specified project. + * @desc Retrieves a list of disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.diskTypes.list * @memberOf! () * @@ -19863,7 +19997,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.delete - * @desc Deletes the specified externalVpnGateway. + * @desc Deletes the specified externalVpnGateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.delete * @memberOf! () * @@ -19939,7 +20073,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.get - * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.get * @memberOf! () * @@ -20014,7 +20148,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.insert - * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.insert * @memberOf! () * @@ -20090,7 +20224,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.list - * @desc Retrieves the list of ExternalVpnGateway available to the specified project. + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.list * @memberOf! () * @@ -20170,7 +20304,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.setLabels - * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.setLabels * @memberOf! () * @@ -20246,7 +20380,7 @@ export namespace compute_alpha { /** * compute.externalVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.testIamPermissions * @memberOf! () * @@ -20461,7 +20595,7 @@ export namespace compute_alpha { /** * compute.firewalls.delete - * @desc Deletes the specified firewall. + * @desc Deletes the specified firewall. (== suppress_warning http-rest-shadowed ==) * @alias compute.firewalls.delete * @memberOf! () * @@ -20536,7 +20670,7 @@ export namespace compute_alpha { /** * compute.firewalls.get - * @desc Returns the specified firewall. + * @desc Returns the specified firewall. (== suppress_warning http-rest-shadowed ==) * @alias compute.firewalls.get * @memberOf! () * @@ -20608,7 +20742,7 @@ export namespace compute_alpha { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data included in the request. + * @desc Creates a firewall rule in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.firewalls.insert * @memberOf! () * @@ -20682,7 +20816,7 @@ export namespace compute_alpha { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified project. + * @desc Retrieves the list of firewall rules available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.firewalls.list * @memberOf! () * @@ -20758,7 +20892,7 @@ export namespace compute_alpha { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.firewalls.patch * @memberOf! () * @@ -20834,7 +20968,7 @@ export namespace compute_alpha { /** * compute.firewalls.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.firewalls.testIamPermissions * @memberOf! () * @@ -20914,7 +21048,7 @@ export namespace compute_alpha { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags. + * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. (== suppress_warning http-rest-shadowed ==) * @alias compute.firewalls.update * @memberOf! () * @@ -21148,7 +21282,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.aggregatedList - * @desc Retrieves an aggregated list of forwarding rules. + * @desc Retrieves an aggregated list of forwarding rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.aggregatedList * @memberOf! () * @@ -21235,7 +21369,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.delete - * @desc Deletes the specified ForwardingRule resource. + * @desc Deletes the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.delete * @memberOf! () * @@ -21312,7 +21446,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.get - * @desc Returns the specified ForwardingRule resource. + * @desc Returns the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.get * @memberOf! () * @@ -21388,7 +21522,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.insert * @memberOf! () * @@ -21465,7 +21599,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.list * @memberOf! () * @@ -21544,7 +21678,7 @@ export namespace compute_alpha { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.patch * @memberOf! () * @@ -21622,7 +21756,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.setLabels * @memberOf! () * @@ -21700,7 +21834,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.setTarget * @memberOf! () * @@ -21778,7 +21912,7 @@ export namespace compute_alpha { /** * compute.forwardingRules.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.testIamPermissions * @memberOf! () * @@ -22108,7 +22242,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.delete - * @desc Deletes the specified address resource. + * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalAddresses.delete * @memberOf! () * @@ -22184,7 +22318,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalAddresses.get * @memberOf! () * @@ -22257,7 +22391,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalAddresses.insert * @memberOf! () * @@ -22332,7 +22466,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.list - * @desc Retrieves a list of global addresses. + * @desc Retrieves a list of global addresses. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalAddresses.list * @memberOf! () * @@ -22409,7 +22543,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.setLabels - * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalAddresses.setLabels * @memberOf! () * @@ -22485,7 +22619,7 @@ export namespace compute_alpha { /** * compute.globalAddresses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalAddresses.testIamPermissions * @memberOf! () * @@ -22700,7 +22834,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.delete - * @desc Deletes the specified GlobalForwardingRule resource. + * @desc Deletes the specified GlobalForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.delete * @memberOf! () * @@ -22776,7 +22910,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.get * @memberOf! () * @@ -22851,7 +22985,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.insert * @memberOf! () * @@ -22927,7 +23061,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.list * @memberOf! () * @@ -23005,7 +23139,7 @@ export namespace compute_alpha { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.patch * @memberOf! () * @@ -23082,7 +23216,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.setLabels * @memberOf! () * @@ -23158,7 +23292,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.setTarget * @memberOf! () * @@ -23235,7 +23369,7 @@ export namespace compute_alpha { /** * compute.globalForwardingRules.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.testIamPermissions * @memberOf! () * @@ -23500,7 +23634,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.attachNetworkEndpoints - * @desc Attach a network endpoint to the specified network endpoint group. + * @desc Attach a network endpoint to the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalNetworkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -23579,7 +23713,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.delete - * @desc Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. + * @desc Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalNetworkEndpointGroups.delete * @memberOf! () * @@ -23655,7 +23789,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.detachNetworkEndpoints - * @desc Detach the network endpoint from the specified network endpoint group. + * @desc Detach the network endpoint from the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalNetworkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -23734,7 +23868,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalNetworkEndpointGroups.get * @memberOf! () * @@ -23811,7 +23945,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalNetworkEndpointGroups.insert * @memberOf! () * @@ -23887,7 +24021,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the specified project. + * @desc Retrieves the list of network endpoint groups that are located in the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalNetworkEndpointGroups.list * @memberOf! () * @@ -23967,7 +24101,7 @@ export namespace compute_alpha { /** * compute.globalNetworkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint group. + * @desc Lists the network endpoints in the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalNetworkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -24244,7 +24378,7 @@ export namespace compute_alpha { /** * compute.globalOperations.aggregatedList - * @desc Retrieves an aggregated list of all operations. + * @desc Retrieves an aggregated list of all operations. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOperations.aggregatedList * @memberOf! () * @@ -24326,7 +24460,7 @@ export namespace compute_alpha { /** * compute.globalOperations.delete - * @desc Deletes the specified Operations resource. + * @desc Deletes the specified Operations resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOperations.delete * @memberOf! () * @@ -24399,7 +24533,7 @@ export namespace compute_alpha { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOperations.get * @memberOf! () * @@ -24474,7 +24608,7 @@ export namespace compute_alpha { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the specified project. + * @desc Retrieves a list of Operation resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOperations.list * @memberOf! () * @@ -24551,7 +24685,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 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. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOperations.wait * @memberOf! () * @@ -24738,7 +24872,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.delete - * @desc Deletes the specified Operations resource. + * @desc Deletes the specified Operations resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOrganizationOperations.delete * @memberOf! () * @@ -24811,7 +24945,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOrganizationOperations.get * @memberOf! () * @@ -24886,7 +25020,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.list - * @desc Retrieves a list of Operation resources contained within the specified organization. + * @desc Retrieves a list of Operation resources contained within the specified organization. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOrganizationOperations.list * @memberOf! () * @@ -24963,7 +25097,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 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. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalOrganizationOperations.wait * @memberOf! () * @@ -25122,7 +25256,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.delete - * @desc Deletes the specified global PublicDelegatedPrefix. + * @desc Deletes the specified global PublicDelegatedPrefix. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalPublicDelegatedPrefixes.delete * @memberOf! () * @@ -25198,7 +25332,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.get - * @desc Returns the specified global PublicDelegatedPrefix resource. + * @desc Returns the specified global PublicDelegatedPrefix resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalPublicDelegatedPrefixes.get * @memberOf! () * @@ -25275,7 +25409,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.insert - * @desc Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request. + * @desc Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalPublicDelegatedPrefixes.insert * @memberOf! () * @@ -25351,7 +25485,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.list - * @desc Lists the global PublicDelegatedPrefixes for a project. + * @desc Lists the global PublicDelegatedPrefixes for a project. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalPublicDelegatedPrefixes.list * @memberOf! () * @@ -25436,7 +25570,7 @@ export namespace compute_alpha { /** * compute.globalPublicDelegatedPrefixes.patch - * @desc Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalPublicDelegatedPrefixes.patch * @memberOf! () * @@ -25631,7 +25765,7 @@ export namespace compute_alpha { /** * compute.healthChecks.aggregatedList - * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. + * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.aggregatedList * @memberOf! () * @@ -25716,7 +25850,7 @@ export namespace compute_alpha { /** * compute.healthChecks.delete - * @desc Deletes the specified HealthCheck resource. + * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.delete * @memberOf! () * @@ -25792,7 +25926,7 @@ export namespace compute_alpha { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.get * @memberOf! () * @@ -25866,7 +26000,7 @@ export namespace compute_alpha { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.insert * @memberOf! () * @@ -25941,7 +26075,7 @@ export namespace compute_alpha { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.list * @memberOf! () * @@ -26018,7 +26152,7 @@ export namespace compute_alpha { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.patch * @memberOf! () * @@ -26095,7 +26229,7 @@ export namespace compute_alpha { /** * compute.healthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.testIamPermissions * @memberOf! () * @@ -26175,7 +26309,7 @@ export namespace compute_alpha { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.update * @memberOf! () * @@ -26443,7 +26577,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.delete - * @desc Deletes the specified HttpHealthCheck resource. + * @desc Deletes the specified HttpHealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpHealthChecks.delete * @memberOf! () * @@ -26519,7 +26653,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpHealthChecks.get * @memberOf! () * @@ -26594,7 +26728,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpHealthChecks.insert * @memberOf! () * @@ -26670,7 +26804,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpHealthChecks.list * @memberOf! () * @@ -26748,7 +26882,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpHealthChecks.patch * @memberOf! () * @@ -26825,7 +26959,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpHealthChecks.testIamPermissions * @memberOf! () * @@ -26905,7 +27039,7 @@ export namespace compute_alpha { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpHealthChecks.update * @memberOf! () * @@ -27146,7 +27280,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.delete - * @desc Deletes the specified HttpsHealthCheck resource. + * @desc Deletes the specified HttpsHealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpsHealthChecks.delete * @memberOf! () * @@ -27222,7 +27356,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpsHealthChecks.get * @memberOf! () * @@ -27297,7 +27431,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpsHealthChecks.insert * @memberOf! () * @@ -27373,7 +27507,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpsHealthChecks.list * @memberOf! () * @@ -27453,7 +27587,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpsHealthChecks.patch * @memberOf! () * @@ -27530,7 +27664,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpsHealthChecks.testIamPermissions * @memberOf! () * @@ -27610,7 +27744,7 @@ export namespace compute_alpha { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.httpsHealthChecks.update * @memberOf! () * @@ -27851,7 +27985,7 @@ export namespace compute_alpha { /** * compute.images.delete - * @desc Deletes the specified image. + * @desc Deletes the specified image. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.delete * @memberOf! () * @@ -27926,7 +28060,7 @@ export namespace compute_alpha { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.deprecate * @memberOf! () * @@ -28002,7 +28136,7 @@ export namespace compute_alpha { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by making a list() request. + * @desc Returns the specified image. Gets a list of available images by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.get * @memberOf! () * @@ -28074,7 +28208,7 @@ export namespace compute_alpha { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not deprecated. + * @desc Returns the latest image that is part of an image family and is not deprecated. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.getFromFamily * @memberOf! () * @@ -28147,7 +28281,7 @@ export namespace compute_alpha { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.getIamPolicy * @memberOf! () * @@ -28221,7 +28355,7 @@ export namespace compute_alpha { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included in the request. + * @desc Creates an image in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.insert * @memberOf! () * @@ -28296,7 +28430,7 @@ export namespace compute_alpha { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.list * @memberOf! () * @@ -28372,7 +28506,7 @@ export namespace compute_alpha { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.setIamPolicy * @memberOf! () * @@ -28446,7 +28580,7 @@ export namespace compute_alpha { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.setLabels * @memberOf! () * @@ -28521,7 +28655,7 @@ export namespace compute_alpha { /** * compute.images.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.testIamPermissions * @memberOf! () * @@ -28816,7 +28950,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.abandonInstances * @memberOf! () * @@ -28894,7 +29028,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by zone. + * @desc Retrieves the list of managed instance groups and groups them by zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.aggregatedList * @memberOf! () * @@ -28981,7 +29115,7 @@ export namespace compute_alpha { /** * 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. + * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -29060,7 +29194,7 @@ export namespace compute_alpha { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.createInstances * @memberOf! () * @@ -29138,7 +29272,7 @@ export namespace compute_alpha { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.delete * @memberOf! () * @@ -29215,7 +29349,7 @@ export namespace compute_alpha { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.deleteInstances * @memberOf! () * @@ -29293,7 +29427,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.deletePerInstanceConfigs - * @desc Deletes selected per-instance configs for the managed instance group. + * @desc Deletes selected per-instance configs for the managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.deletePerInstanceConfigs * @memberOf! () * @@ -29372,7 +29506,7 @@ export namespace compute_alpha { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.get * @memberOf! () * @@ -29450,7 +29584,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.insert * @memberOf! () * @@ -29527,7 +29661,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.list * @memberOf! () * @@ -29608,7 +29742,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.listErrors - * @desc Lists all errors thrown by actions on instances for a given managed instance group. + * @desc Lists all errors thrown by actions on instances for a given managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.listErrors * @memberOf! () * @@ -29705,7 +29839,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.listManagedInstances * @memberOf! () * @@ -29809,7 +29943,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.listPerInstanceConfigs - * @desc Lists all of the per-instance configs defined for the managed instance group. + * @desc Lists all of the per-instance configs defined for the managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.listPerInstanceConfigs * @memberOf! () * @@ -29913,7 +30047,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.patch * @memberOf! () * @@ -29991,7 +30125,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.patchPerInstanceConfigs - * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. + * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.patchPerInstanceConfigs * @memberOf! () * @@ -30071,7 +30205,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.recreateInstances * @memberOf! () * @@ -30149,7 +30283,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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. + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.resize * @memberOf! () * @@ -30227,7 +30361,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.resizeAdvanced - * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or 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. + * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or 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. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.resizeAdvanced * @memberOf! () * @@ -30305,7 +30439,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. + * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.setAutoHealingPolicies * @memberOf! () * @@ -30385,7 +30519,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.setInstanceTemplate * @memberOf! () * @@ -30463,7 +30597,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.setTargetPools * @memberOf! () * @@ -30541,7 +30675,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.testIamPermissions * @memberOf! () * @@ -30622,7 +30756,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.update * @memberOf! () * @@ -30700,7 +30834,7 @@ export namespace compute_alpha { /** * compute.instanceGroupManagers.updatePerInstanceConfigs - * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. + * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.updatePerInstanceConfigs * @memberOf! () * @@ -31476,7 +31610,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.addInstances * @memberOf! () * @@ -31554,7 +31688,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.aggregatedList - * @desc Retrieves the list of instance groups and sorts them by zone. + * @desc Retrieves the list of instance groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.aggregatedList * @memberOf! () * @@ -31639,7 +31773,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.delete * @memberOf! () * @@ -31716,7 +31850,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.get * @memberOf! () * @@ -31792,7 +31926,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the parameters that are included in the request. + * @desc Creates an instance group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.insert * @memberOf! () * @@ -31869,7 +32003,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the specified project and zone. + * @desc Retrieves the list of instance groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.list * @memberOf! () * @@ -31948,7 +32082,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.listInstances - * @desc Lists the instances in the specified instance group. + * @desc Lists the instances in the specified instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.listInstances * @memberOf! () * @@ -32036,7 +32170,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, but does not delete those instances. 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 before the VM instance is removed or deleted. + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. 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 before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.removeInstances * @memberOf! () * @@ -32114,7 +32248,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.setNamedPorts - * @desc Sets the named ports for the specified instance group. + * @desc Sets the named ports for the specified instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.setNamedPorts * @memberOf! () * @@ -32192,7 +32326,7 @@ export namespace compute_alpha { /** * compute.instanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroups.testIamPermissions * @memberOf! () * @@ -32563,7 +32697,7 @@ export namespace compute_alpha { /** * compute.instances.addAccessConfig - * @desc Adds an access config to an instance's network interface. + * @desc Adds an access config to an instance's network interface. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.addAccessConfig * @memberOf! () * @@ -32642,7 +32776,7 @@ export namespace compute_alpha { /** * compute.instances.addResourcePolicies - * @desc Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. + * @desc Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.addResourcePolicies * @memberOf! () * @@ -32720,7 +32854,7 @@ export namespace compute_alpha { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.aggregatedList * @memberOf! () * @@ -32801,7 +32935,7 @@ export namespace compute_alpha { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.attachDisk * @memberOf! () * @@ -32880,7 +33014,7 @@ export namespace compute_alpha { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.delete * @memberOf! () * @@ -32956,7 +33090,7 @@ export namespace compute_alpha { /** * compute.instances.deleteAccessConfig - * @desc Deletes an access config from an instance's network interface. + * @desc Deletes an access config from an instance's network interface. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.deleteAccessConfig * @memberOf! () * @@ -33041,7 +33175,7 @@ export namespace compute_alpha { /** * compute.instances.detachDisk - * @desc Detaches a disk from an instance. + * @desc Detaches a disk from an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.detachDisk * @memberOf! () * @@ -33119,7 +33253,7 @@ export namespace compute_alpha { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.get * @memberOf! () * @@ -33192,7 +33326,7 @@ export namespace compute_alpha { /** * compute.instances.getEffectiveFirewalls - * @desc Returns effective firewalls applied to an interface of the instance. + * @desc Returns effective firewalls applied to an interface of the instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getEffectiveFirewalls * @memberOf! () * @@ -33286,7 +33420,7 @@ export namespace compute_alpha { /** * compute.instances.getGuestAttributes - * @desc Returns the specified guest attributes entry. + * @desc Returns the specified guest attributes entry. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getGuestAttributes * @memberOf! () * @@ -33366,7 +33500,7 @@ export namespace compute_alpha { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -33441,7 +33575,7 @@ export namespace compute_alpha { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified instance. + * @desc Returns the last 1 MB of serial port output from the specified instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getSerialPortOutput * @memberOf! () * @@ -33521,7 +33655,7 @@ export namespace compute_alpha { /** * compute.instances.getShieldedInstanceIdentity - * @desc Returns the Shielded Instance Identity of an instance + * @desc Returns the Shielded Instance Identity of an instance (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getShieldedInstanceIdentity * @memberOf! () * @@ -33601,7 +33735,7 @@ export namespace compute_alpha { /** * compute.instances.getShieldedVmIdentity - * @desc Returns the Shielded VM Identity of an instance + * @desc Returns the Shielded VM Identity of an instance (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getShieldedVmIdentity * @memberOf! () * @@ -33679,7 +33813,7 @@ export namespace compute_alpha { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the data included in the request. + * @desc Creates an instance resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.insert * @memberOf! () * @@ -33757,7 +33891,7 @@ export namespace compute_alpha { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified zone. + * @desc Retrieves the list of instances contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.list * @memberOf! () * @@ -33835,7 +33969,7 @@ export namespace compute_alpha { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.listReferrers * @memberOf! () * @@ -33919,7 +34053,7 @@ export namespace compute_alpha { /** * compute.instances.removeResourcePolicies - * @desc Removes resource policies from an instance. + * @desc Removes resource policies from an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.removeResourcePolicies * @memberOf! () * @@ -33999,7 +34133,7 @@ export namespace compute_alpha { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.reset * @memberOf! () * @@ -34075,7 +34209,7 @@ export namespace compute_alpha { /** * compute.instances.resume - * @desc Resumes an instance that was suspended using the instances().suspend method. + * @desc Resumes an instance that was suspended using the instances().suspend method. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.resume * @memberOf! () * @@ -34152,7 +34286,7 @@ export namespace compute_alpha { /** * compute.instances.setDeletionProtection - * @desc Sets deletion protection on the instance. + * @desc Sets deletion protection on the instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setDeletionProtection * @memberOf! () * @@ -34232,7 +34366,7 @@ export namespace compute_alpha { /** * compute.instances.setDiskAutoDelete - * @desc Sets the auto-delete flag for a disk attached to an instance. + * @desc Sets the auto-delete flag for a disk attached to an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setDiskAutoDelete * @memberOf! () * @@ -34317,7 +34451,7 @@ export namespace compute_alpha { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -34392,7 +34526,7 @@ export namespace compute_alpha { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setLabels * @memberOf! () * @@ -34470,7 +34604,7 @@ export namespace compute_alpha { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setMachineResources * @memberOf! () * @@ -34548,7 +34682,7 @@ export namespace compute_alpha { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type specified in the request. + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setMachineType * @memberOf! () * @@ -34626,7 +34760,7 @@ export namespace compute_alpha { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in the request. + * @desc Sets metadata for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setMetadata * @memberOf! () * @@ -34704,7 +34838,7 @@ export namespace compute_alpha { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setMinCpuPlatform * @memberOf! () * @@ -34782,7 +34916,7 @@ export namespace compute_alpha { /** * compute.instances.setName - * @desc Sets name of an instance. + * @desc Sets name of an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setName * @memberOf! () * @@ -34860,7 +34994,7 @@ export namespace compute_alpha { /** * compute.instances.setScheduling - * @desc Sets an instance's scheduling options. + * @desc Sets an instance's scheduling options. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setScheduling * @memberOf! () * @@ -34938,7 +35072,7 @@ export namespace compute_alpha { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setServiceAccount * @memberOf! () * @@ -35016,7 +35150,7 @@ export namespace compute_alpha { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -35096,7 +35230,7 @@ export namespace compute_alpha { /** * compute.instances.setShieldedVmIntegrityPolicy - * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setShieldedVmIntegrityPolicy * @memberOf! () * @@ -35176,7 +35310,7 @@ export namespace compute_alpha { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included in the request. + * @desc Sets network tags for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setTags * @memberOf! () * @@ -35254,7 +35388,7 @@ export namespace compute_alpha { /** * compute.instances.simulateMaintenanceEvent - * @desc Simulates a maintenance event on the instance. + * @desc Simulates a maintenance event on the instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.simulateMaintenanceEvent * @memberOf! () * @@ -35332,7 +35466,7 @@ export namespace compute_alpha { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.start * @memberOf! () * @@ -35408,7 +35542,7 @@ export namespace compute_alpha { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.startWithEncryptionKey * @memberOf! () * @@ -35488,7 +35622,7 @@ export namespace compute_alpha { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.stop * @memberOf! () * @@ -35565,7 +35699,7 @@ export namespace compute_alpha { /** * compute.instances.suspend - * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. + * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.suspend * @memberOf! () * @@ -35643,7 +35777,7 @@ export namespace compute_alpha { /** * compute.instances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.testIamPermissions * @memberOf! () * @@ -35724,7 +35858,7 @@ export namespace compute_alpha { /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateAccessConfig * @memberOf! () * @@ -35803,7 +35937,7 @@ export namespace compute_alpha { /** * compute.instances.updateDisplayDevice - * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateDisplayDevice * @memberOf! () * @@ -35881,7 +36015,7 @@ export namespace compute_alpha { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH semantics. + * @desc Updates an instance's network interface. This method follows PATCH semantics. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateNetworkInterface * @memberOf! () * @@ -35962,7 +36096,7 @@ export namespace compute_alpha { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -36042,7 +36176,7 @@ export namespace compute_alpha { /** * compute.instances.updateShieldedVmConfig - * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateShieldedVmConfig * @memberOf! () * @@ -37387,7 +37521,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.delete * @memberOf! () * @@ -37463,7 +37597,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.get * @memberOf! () * @@ -37538,7 +37672,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -37612,7 +37746,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.insert * @memberOf! () * @@ -37688,7 +37822,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within the specified project. + * @desc Retrieves a list of instance templates that are contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.list * @memberOf! () * @@ -37768,7 +37902,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -37842,7 +37976,7 @@ export namespace compute_alpha { /** * compute.instanceTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.testIamPermissions * @memberOf! () * @@ -38077,7 +38211,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.aggregatedList - * @desc Retrieves an aggregated list of interconnect attachments. + * @desc Retrieves an aggregated list of interconnect attachments. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.aggregatedList * @memberOf! () * @@ -38172,7 +38306,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.delete - * @desc Deletes the specified interconnect attachment. + * @desc Deletes the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.delete * @memberOf! () * @@ -38249,7 +38383,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.get - * @desc Returns the specified interconnect attachment. + * @desc Returns the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.get * @memberOf! () * @@ -38327,7 +38461,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.getIamPolicy * @memberOf! () * @@ -38402,7 +38536,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.insert * @memberOf! () * @@ -38480,7 +38614,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the specified region. + * @desc Retrieves the list of interconnect attachments contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.list * @memberOf! () * @@ -38566,7 +38700,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -38644,7 +38778,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.setIamPolicy * @memberOf! () * @@ -38719,7 +38853,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.setLabels - * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.setLabels * @memberOf! () * @@ -38797,7 +38931,7 @@ export namespace compute_alpha { /** * compute.interconnectAttachments.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.testIamPermissions * @memberOf! () * @@ -39151,7 +39285,7 @@ export namespace compute_alpha { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectLocations.get * @memberOf! () * @@ -39228,7 +39362,7 @@ export namespace compute_alpha { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the specified project. + * @desc Retrieves the list of interconnect locations available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectLocations.list * @memberOf! () * @@ -39308,7 +39442,7 @@ export namespace compute_alpha { /** * compute.interconnectLocations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectLocations.testIamPermissions * @memberOf! () * @@ -39461,7 +39595,7 @@ export namespace compute_alpha { /** * compute.interconnects.delete - * @desc Deletes the specified interconnect. + * @desc Deletes the specified interconnect. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.delete * @memberOf! () * @@ -39537,7 +39671,7 @@ export namespace compute_alpha { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.get * @memberOf! () * @@ -39612,7 +39746,7 @@ export namespace compute_alpha { /** * compute.interconnects.getDiagnostics - * @desc Returns the interconnectDiagnostics for the specified interconnect. + * @desc Returns the interconnectDiagnostics for the specified interconnect. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.getDiagnostics * @memberOf! () * @@ -39698,7 +39832,7 @@ export namespace compute_alpha { /** * compute.interconnects.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.getIamPolicy * @memberOf! () * @@ -39772,7 +39906,7 @@ export namespace compute_alpha { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data included in the request. + * @desc Creates a Interconnect in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.insert * @memberOf! () * @@ -39847,7 +39981,7 @@ export namespace compute_alpha { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified project. + * @desc Retrieves the list of interconnect available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.list * @memberOf! () * @@ -39924,7 +40058,7 @@ export namespace compute_alpha { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.patch * @memberOf! () * @@ -40001,7 +40135,7 @@ export namespace compute_alpha { /** * compute.interconnects.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.setIamPolicy * @memberOf! () * @@ -40075,7 +40209,7 @@ export namespace compute_alpha { /** * compute.interconnects.setLabels - * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.setLabels * @memberOf! () * @@ -40151,7 +40285,7 @@ export namespace compute_alpha { /** * compute.interconnects.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.testIamPermissions * @memberOf! () * @@ -40448,7 +40582,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenseCodes.get * @memberOf! () * @@ -40522,7 +40656,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenseCodes.getIamPolicy * @memberOf! () * @@ -40596,7 +40730,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenseCodes.setIamPolicy * @memberOf! () * @@ -40670,7 +40804,7 @@ export namespace compute_alpha { /** * compute.licenseCodes.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenseCodes.testIamPermissions * @memberOf! () * @@ -40835,7 +40969,7 @@ export namespace compute_alpha { /** * compute.licenses.delete - * @desc Deletes the specified license. + * @desc Deletes the specified license. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.delete * @memberOf! () * @@ -40910,7 +41044,7 @@ export namespace compute_alpha { /** * compute.licenses.get - * @desc Returns the specified License resource. + * @desc Returns the specified License resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.get * @memberOf! () * @@ -40982,7 +41116,7 @@ export namespace compute_alpha { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -41056,7 +41190,7 @@ export namespace compute_alpha { /** * compute.licenses.insert - * @desc Create a License resource in the specified project. + * @desc Create a License resource in the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.insert * @memberOf! () * @@ -41130,7 +41264,7 @@ export namespace compute_alpha { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.list * @memberOf! () * @@ -41208,7 +41342,7 @@ export namespace compute_alpha { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -41282,7 +41416,7 @@ export namespace compute_alpha { /** * compute.licenses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.testIamPermissions * @memberOf! () * @@ -41513,7 +41647,7 @@ export namespace compute_alpha { /** * compute.machineImages.delete - * @desc Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. + * @desc Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineImages.delete * @memberOf! () * @@ -41589,7 +41723,7 @@ export namespace compute_alpha { /** * compute.machineImages.get - * @desc Returns the specified machine image. Gets a list of available machine images by making a list() request. + * @desc Returns the specified machine image. Gets a list of available machine images by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineImages.get * @memberOf! () * @@ -41664,7 +41798,7 @@ export namespace compute_alpha { /** * compute.machineImages.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineImages.getIamPolicy * @memberOf! () * @@ -41738,7 +41872,7 @@ export namespace compute_alpha { /** * compute.machineImages.insert - * @desc Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. + * @desc Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineImages.insert * @memberOf! () * @@ -41814,7 +41948,7 @@ export namespace compute_alpha { /** * compute.machineImages.list - * @desc Retrieves a list of machine images that are contained within the specified project. + * @desc Retrieves a list of machine images that are contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineImages.list * @memberOf! () * @@ -41891,7 +42025,7 @@ export namespace compute_alpha { /** * compute.machineImages.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineImages.setIamPolicy * @memberOf! () * @@ -41965,7 +42099,7 @@ export namespace compute_alpha { /** * compute.machineImages.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineImages.testIamPermissions * @memberOf! () * @@ -42204,7 +42338,7 @@ export namespace compute_alpha { /** * compute.machineTypes.aggregatedList - * @desc Retrieves an aggregated list of machine types. + * @desc Retrieves an aggregated list of machine types. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineTypes.aggregatedList * @memberOf! () * @@ -42289,7 +42423,7 @@ export namespace compute_alpha { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineTypes.get * @memberOf! () * @@ -42364,7 +42498,7 @@ export namespace compute_alpha { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified project. + * @desc Retrieves a list of machine types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.machineTypes.list * @memberOf! () * @@ -42530,7 +42664,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by zone. + * @desc Retrieves the list of network endpoint groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * @@ -42617,7 +42751,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network endpoint group. + * @desc Attach a list of network endpoints to the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -42697,7 +42831,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. + * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.delete * @memberOf! () * @@ -42774,7 +42908,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network endpoint group. + * @desc Detach a list of network endpoints from the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -42854,7 +42988,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -42932,7 +43066,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -43009,7 +43143,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -43090,7 +43224,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint group. + * @desc Lists the network endpoints in the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -43194,7 +43328,7 @@ export namespace compute_alpha { /** * compute.networkEndpointGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.testIamPermissions * @memberOf! () * @@ -43536,7 +43670,7 @@ export namespace compute_alpha { /** * compute.networks.addPeering - * @desc Adds a peering to the specified network. + * @desc Adds a peering to the specified network. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.addPeering * @memberOf! () * @@ -43613,7 +43747,7 @@ export namespace compute_alpha { /** * compute.networks.delete - * @desc Deletes the specified network. + * @desc Deletes the specified network. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.delete * @memberOf! () * @@ -43688,7 +43822,7 @@ export namespace compute_alpha { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by making a list() request. + * @desc Returns the specified network. Gets a list of available networks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.get * @memberOf! () * @@ -43760,7 +43894,7 @@ export namespace compute_alpha { /** * compute.networks.getEffectiveFirewalls - * @desc Returns the effective firewalls on a given network. + * @desc Returns the effective firewalls on a given network. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.getEffectiveFirewalls * @memberOf! () * @@ -43852,7 +43986,7 @@ export namespace compute_alpha { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included in the request. + * @desc Creates a network in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.insert * @memberOf! () * @@ -43926,7 +44060,7 @@ export namespace compute_alpha { /** * compute.networks.list - * @desc Retrieves the list of networks available to the specified project. + * @desc Retrieves the list of networks available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.list * @memberOf! () * @@ -44002,7 +44136,7 @@ export namespace compute_alpha { /** * compute.networks.listIpAddresses - * @desc Lists the internal IP addresses in the specified network. + * @desc Lists the internal IP addresses in the specified network. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.listIpAddresses * @memberOf! () * @@ -44084,7 +44218,7 @@ export namespace compute_alpha { /** * compute.networks.listIpOwners - * @desc Lists the internal IP owners in the specified network. + * @desc Lists the internal IP owners in the specified network. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.listIpOwners * @memberOf! () * @@ -44168,7 +44302,7 @@ export namespace compute_alpha { /** * compute.networks.listPeeringRoutes - * @desc Lists the peering routes exchanged over peering connection. + * @desc Lists the peering routes exchanged over peering connection. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.listPeeringRoutes * @memberOf! () * @@ -44257,7 +44391,7 @@ export namespace compute_alpha { /** * compute.networks.patch - * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. + * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.patch * @memberOf! () * @@ -44333,7 +44467,7 @@ export namespace compute_alpha { /** * compute.networks.removePeering - * @desc Removes a peering from the specified network. + * @desc Removes a peering from the specified network. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.removePeering * @memberOf! () * @@ -44410,7 +44544,7 @@ export namespace compute_alpha { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet mode. + * @desc Switches the network mode from auto subnet mode to custom subnet mode. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.switchToCustomMode * @memberOf! () * @@ -44486,7 +44620,7 @@ export namespace compute_alpha { /** * compute.networks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.testIamPermissions * @memberOf! () * @@ -44566,7 +44700,7 @@ export namespace compute_alpha { /** * compute.networks.updatePeering - * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes + * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.updatePeering * @memberOf! () * @@ -45020,7 +45154,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.addNodes - * @desc Adds specified number of nodes to the node group. + * @desc Adds specified number of nodes to the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.addNodes * @memberOf! () * @@ -45098,7 +45232,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -45180,7 +45314,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.delete - * @desc Deletes the specified NodeGroup resource. + * @desc Deletes the specified NodeGroup resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.delete * @memberOf! () * @@ -45257,7 +45391,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.deleteNodes - * @desc Deletes specified nodes from the node group. + * @desc Deletes specified nodes from the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.deleteNodes * @memberOf! () * @@ -45335,7 +45469,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.get * @memberOf! () * @@ -45410,7 +45544,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -45485,7 +45619,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the data included in the request. + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.insert * @memberOf! () * @@ -45563,7 +45697,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.list * @memberOf! () * @@ -45641,7 +45775,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.listNodes - * @desc Lists nodes in the node group. + * @desc Lists nodes in the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.listNodes * @memberOf! () * @@ -45721,7 +45855,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.setAutoscalingPolicy - * @desc Sets the autoscaling policy of the node group. + * @desc Sets the autoscaling policy of the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.setAutoscalingPolicy * @memberOf! () * @@ -45801,7 +45935,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -45876,7 +46010,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.setNodeTemplate - * @desc Updates the node template of the node group. + * @desc Updates the node template of the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.setNodeTemplate * @memberOf! () * @@ -45954,7 +46088,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.testIamPermissions * @memberOf! () * @@ -46400,7 +46534,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.aggregatedList - * @desc Retrieves an aggregated list of node templates. + * @desc Retrieves an aggregated list of node templates. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.aggregatedList * @memberOf! () * @@ -46485,7 +46619,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.delete - * @desc Deletes the specified NodeTemplate resource. + * @desc Deletes the specified NodeTemplate resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.delete * @memberOf! () * @@ -46562,7 +46696,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.get * @memberOf! () * @@ -46638,7 +46772,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -46713,7 +46847,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -46790,7 +46924,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified project. + * @desc Retrieves a list of node templates available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.list * @memberOf! () * @@ -46869,7 +47003,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -46944,7 +47078,7 @@ export namespace compute_alpha { /** * compute.nodeTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.testIamPermissions * @memberOf! () * @@ -47236,7 +47370,7 @@ export namespace compute_alpha { /** * compute.nodeTypes.aggregatedList - * @desc Retrieves an aggregated list of node types. + * @desc Retrieves an aggregated list of node types. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.aggregatedList * @memberOf! () * @@ -47317,7 +47451,7 @@ export namespace compute_alpha { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node types by making a list() request. + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.get * @memberOf! () * @@ -47390,7 +47524,7 @@ export namespace compute_alpha { /** * compute.nodeTypes.list - * @desc Retrieves a list of node types available to the specified project. + * @desc Retrieves a list of node types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.list * @memberOf! () * @@ -47554,7 +47688,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.addAssociation - * @desc Inserts an association for the specified security policy. + * @desc Inserts an association for the specified security policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.addAssociation * @memberOf! () * @@ -47631,7 +47765,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.addRule - * @desc Inserts a rule into a security policy. + * @desc Inserts a rule into a security policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.addRule * @memberOf! () * @@ -47707,7 +47841,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.copyRules - * @desc Copies rules to the specified security policy. + * @desc Copies rules to the specified security policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.copyRules * @memberOf! () * @@ -47783,7 +47917,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.delete - * @desc Deletes the specified policy. + * @desc Deletes the specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.delete * @memberOf! () * @@ -47858,7 +47992,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.get - * @desc List all of the ordered rules present in a single specified policy. + * @desc List all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.get * @memberOf! () * @@ -47932,7 +48066,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.getAssociation - * @desc Gets an association with the specified name. + * @desc Gets an association with the specified name. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.getAssociation * @memberOf! () * @@ -48014,7 +48148,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.getRule - * @desc Gets a rule at the specified priority. + * @desc Gets a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.getRule * @memberOf! () * @@ -48089,7 +48223,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.insert - * @desc Creates a new policy in the specified project using the data included in the request. + * @desc Creates a new policy in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.insert * @memberOf! () * @@ -48165,7 +48299,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.list - * @desc List all the policies that have been configured for the specified project. + * @desc List all the policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.list * @memberOf! () * @@ -48243,7 +48377,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.listAssociations - * @desc Lists associations of a specified target, i.e., organization or folder. + * @desc Lists associations of a specified target, i.e., organization or folder. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.listAssociations * @memberOf! () * @@ -48343,7 +48477,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.move - * @desc Moves the specified security policy. + * @desc Moves the specified security policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.move * @memberOf! () * @@ -48419,7 +48553,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.patch - * @desc Patches the specified policy with the data included in the request. + * @desc Patches the specified policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.patch * @memberOf! () * @@ -48495,7 +48629,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.patchRule - * @desc Patches a rule at the specified priority. + * @desc Patches a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.patchRule * @memberOf! () * @@ -48572,7 +48706,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.removeAssociation - * @desc Removes an association for the specified security policy. + * @desc Removes an association for the specified security policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.removeAssociation * @memberOf! () * @@ -48648,7 +48782,7 @@ export namespace compute_alpha { /** * compute.organizationSecurityPolicies.removeRule - * @desc Deletes a rule at the specified priority. + * @desc Deletes a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.organizationSecurityPolicies.removeRule * @memberOf! () * @@ -49025,7 +49159,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.aggregatedList - * @desc Retrieves an aggregated list of packetMirrorings. + * @desc Retrieves an aggregated list of packetMirrorings. (== suppress_warning http-rest-shadowed ==) * @alias compute.packetMirrorings.aggregatedList * @memberOf! () * @@ -49112,7 +49246,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.delete - * @desc Deletes the specified PacketMirroring resource. + * @desc Deletes the specified PacketMirroring resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.packetMirrorings.delete * @memberOf! () * @@ -49189,7 +49323,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.get - * @desc Returns the specified PacketMirroring resource. + * @desc Returns the specified PacketMirroring resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.packetMirrorings.get * @memberOf! () * @@ -49265,7 +49399,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.insert - * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. + * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.packetMirrorings.insert * @memberOf! () * @@ -49342,7 +49476,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.list - * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. + * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.packetMirrorings.list * @memberOf! () * @@ -49421,7 +49555,7 @@ export namespace compute_alpha { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.packetMirrorings.patch * @memberOf! () * @@ -49499,7 +49633,7 @@ export namespace compute_alpha { /** * compute.packetMirrorings.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.packetMirrorings.testIamPermissions * @memberOf! () * @@ -49771,7 +49905,7 @@ export namespace compute_alpha { /** * compute.projects.disableXpnHost - * @desc Disable this project as a shared VPC host project. + * @desc Disable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.disableXpnHost * @memberOf! () * @@ -49845,7 +49979,7 @@ export namespace compute_alpha { /** * compute.projects.disableXpnResource - * @desc Disable a service resource (also known as service project) associated with this host project. + * @desc Disable a service resource (also known as service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.disableXpnResource * @memberOf! () * @@ -49920,7 +50054,7 @@ export namespace compute_alpha { /** * compute.projects.enableXpnHost - * @desc Enable this project as a shared VPC host project. + * @desc Enable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.enableXpnHost * @memberOf! () * @@ -49994,7 +50128,7 @@ export namespace compute_alpha { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.enableXpnResource * @memberOf! () * @@ -50069,7 +50203,7 @@ export namespace compute_alpha { /** * compute.projects.get - * @desc Returns the specified Project resource. + * @desc Returns the specified Project resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.get * @memberOf! () * @@ -50140,7 +50274,7 @@ export namespace compute_alpha { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.getXpnHost * @memberOf! () * @@ -50211,7 +50345,7 @@ export namespace compute_alpha { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this host project. + * @desc Gets service resources (a.k.a service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.getXpnResources * @memberOf! () * @@ -50292,7 +50426,7 @@ export namespace compute_alpha { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an organization. + * @desc Lists all shared VPC host projects visible to the user in an organization. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.listXpnHosts * @memberOf! () * @@ -50370,7 +50504,7 @@ export namespace compute_alpha { /** * compute.projects.moveDisk - * @desc Moves a persistent disk from one zone to another. + * @desc Moves a persistent disk from one zone to another. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.moveDisk * @memberOf! () * @@ -50445,7 +50579,7 @@ export namespace compute_alpha { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone to another. + * @desc Moves an instance and its attached persistent disks from one zone to another. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.moveInstance * @memberOf! () * @@ -50520,7 +50654,7 @@ export namespace compute_alpha { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project using the data included in the request. + * @desc Sets metadata common to all instances within the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.setCommonInstanceMetadata * @memberOf! () * @@ -50598,7 +50732,7 @@ export namespace compute_alpha { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -50676,7 +50810,7 @@ export namespace compute_alpha { /** * compute.projects.setDefaultServiceAccount - * @desc Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default". + * @desc Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default". (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.setDefaultServiceAccount * @memberOf! () * @@ -50754,7 +50888,7 @@ export namespace compute_alpha { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.setUsageExportBucket * @memberOf! () * @@ -51123,7 +51257,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.delete - * @desc Deletes the specified PublicAdvertisedPrefix + * @desc Deletes the specified PublicAdvertisedPrefix (== suppress_warning http-rest-shadowed ==) * @alias compute.publicAdvertisedPrefixes.delete * @memberOf! () * @@ -51199,7 +51333,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.get - * @desc Returns the specified PublicAdvertisedPrefix resource. + * @desc Returns the specified PublicAdvertisedPrefix resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicAdvertisedPrefixes.get * @memberOf! () * @@ -51276,7 +51410,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.insert - * @desc Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. + * @desc Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicAdvertisedPrefixes.insert * @memberOf! () * @@ -51352,7 +51486,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.list - * @desc Lists the PublicAdvertisedPrefixes for a project. + * @desc Lists the PublicAdvertisedPrefixes for a project. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicAdvertisedPrefixes.list * @memberOf! () * @@ -51437,7 +51571,7 @@ export namespace compute_alpha { /** * compute.publicAdvertisedPrefixes.patch - * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicAdvertisedPrefixes.patch * @memberOf! () * @@ -51632,7 +51766,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.aggregatedList - * @desc Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. + * @desc Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicDelegatedPrefixes.aggregatedList * @memberOf! () * @@ -51721,7 +51855,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.delete - * @desc Deletes the specified PublicDelegatedPrefix in the given region. + * @desc Deletes the specified PublicDelegatedPrefix in the given region. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicDelegatedPrefixes.delete * @memberOf! () * @@ -51798,7 +51932,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.get - * @desc Returns the specified PublicDelegatedPrefix resource in the given region. + * @desc Returns the specified PublicDelegatedPrefix resource in the given region. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicDelegatedPrefixes.get * @memberOf! () * @@ -51876,7 +52010,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.insert - * @desc Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request. + * @desc Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicDelegatedPrefixes.insert * @memberOf! () * @@ -51953,7 +52087,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.list - * @desc Lists the PublicDelegatedPrefixes for a project in the given region. + * @desc Lists the PublicDelegatedPrefixes for a project in the given region. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicDelegatedPrefixes.list * @memberOf! () * @@ -52039,7 +52173,7 @@ export namespace compute_alpha { /** * compute.publicDelegatedPrefixes.patch - * @desc Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.publicDelegatedPrefixes.patch * @memberOf! () * @@ -52283,7 +52417,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.delete - * @desc Deletes the specified autoscaler. + * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionAutoscalers.delete * @memberOf! () * @@ -52360,7 +52494,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.get - * @desc Returns the specified autoscaler. + * @desc Returns the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionAutoscalers.get * @memberOf! () * @@ -52436,7 +52570,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionAutoscalers.insert * @memberOf! () * @@ -52513,7 +52647,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified region. + * @desc Retrieves a list of autoscalers contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionAutoscalers.list * @memberOf! () * @@ -52594,7 +52728,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionAutoscalers.patch * @memberOf! () * @@ -52672,7 +52806,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionAutoscalers.testIamPermissions * @memberOf! () * @@ -52753,7 +52887,7 @@ export namespace compute_alpha { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionAutoscalers.update * @memberOf! () * @@ -53023,7 +53157,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.delete - * @desc Deletes the specified regional BackendService resource. + * @desc Deletes the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionBackendServices.delete * @memberOf! () * @@ -53100,7 +53234,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.get - * @desc Returns the specified regional BackendService resource. + * @desc Returns the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionBackendServices.get * @memberOf! () * @@ -53176,7 +53310,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional BackendService. + * @desc Gets the most recent health check results for this regional BackendService. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionBackendServices.getHealth * @memberOf! () * @@ -53260,7 +53394,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionBackendServices.insert * @memberOf! () * @@ -53337,7 +53471,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionBackendServices.list * @memberOf! () * @@ -53416,7 +53550,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionBackendServices.patch * @memberOf! () * @@ -53494,7 +53628,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionBackendServices.testIamPermissions * @memberOf! () * @@ -53575,7 +53709,7 @@ export namespace compute_alpha { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionBackendServices.update * @memberOf! () * @@ -53870,7 +54004,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.aggregatedList - * @desc Retrieves an aggregated list of commitments. + * @desc Retrieves an aggregated list of commitments. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionCommitments.aggregatedList * @memberOf! () * @@ -53952,7 +54086,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionCommitments.get * @memberOf! () * @@ -54028,7 +54162,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data included in the request. + * @desc Creates a commitment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionCommitments.insert * @memberOf! () * @@ -54105,7 +54239,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified region. + * @desc Retrieves a list of commitments contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionCommitments.list * @memberOf! () * @@ -54184,7 +54318,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionCommitments.testIamPermissions * @memberOf! () * @@ -54265,7 +54399,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.updateReservations - * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. + * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionCommitments.updateReservations * @memberOf! () * @@ -54510,7 +54644,7 @@ export namespace compute_alpha { /** * compute.regionDisks.addResourcePolicies - * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.addResourcePolicies * @memberOf! () * @@ -54588,7 +54722,7 @@ export namespace compute_alpha { /** * compute.regionDisks.createSnapshot - * @desc Creates a snapshot of this regional disk. + * @desc Creates a snapshot of this regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.createSnapshot * @memberOf! () * @@ -54667,7 +54801,7 @@ export namespace compute_alpha { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.delete * @memberOf! () * @@ -54744,7 +54878,7 @@ export namespace compute_alpha { /** * compute.regionDisks.get - * @desc Returns a specified regional persistent disk. + * @desc Returns a specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.get * @memberOf! () * @@ -54817,7 +54951,7 @@ export namespace compute_alpha { /** * compute.regionDisks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.getIamPolicy * @memberOf! () * @@ -54892,7 +55026,7 @@ export namespace compute_alpha { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using the data included in the request. + * @desc Creates a persistent regional disk in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.insert * @memberOf! () * @@ -54970,7 +55104,7 @@ export namespace compute_alpha { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the specified region. + * @desc Retrieves the list of persistent disks contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.list * @memberOf! () * @@ -55046,7 +55180,7 @@ export namespace compute_alpha { /** * compute.regionDisks.removeResourcePolicies - * @desc Removes resource policies from a regional disk. + * @desc Removes resource policies from a regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.removeResourcePolicies * @memberOf! () * @@ -55126,7 +55260,7 @@ export namespace compute_alpha { /** * compute.regionDisks.resize - * @desc Resizes the specified regional persistent disk. + * @desc Resizes the specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.resize * @memberOf! () * @@ -55204,7 +55338,7 @@ export namespace compute_alpha { /** * compute.regionDisks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.setIamPolicy * @memberOf! () * @@ -55279,7 +55413,7 @@ export namespace compute_alpha { /** * compute.regionDisks.setLabels - * @desc Sets the labels on the target regional disk. + * @desc Sets the labels on the target regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.setLabels * @memberOf! () * @@ -55357,7 +55491,7 @@ export namespace compute_alpha { /** * compute.regionDisks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.testIamPermissions * @memberOf! () * @@ -55772,7 +55906,7 @@ export namespace compute_alpha { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -55846,7 +55980,7 @@ export namespace compute_alpha { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified project. + * @desc Retrieves a list of regional disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -55985,7 +56119,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.delete - * @desc Deletes the specified HealthCheck resource. + * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.delete * @memberOf! () * @@ -56062,7 +56196,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.get * @memberOf! () * @@ -56138,7 +56272,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.insert * @memberOf! () * @@ -56215,7 +56349,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.list * @memberOf! () * @@ -56294,7 +56428,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.patch * @memberOf! () * @@ -56372,7 +56506,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.testIamPermissions * @memberOf! () * @@ -56453,7 +56587,7 @@ export namespace compute_alpha { /** * compute.regionHealthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.update * @memberOf! () * @@ -56723,7 +56857,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.delete - * @desc Deletes the specified regional HealthCheckService. + * @desc Deletes the specified regional HealthCheckService. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthCheckServices.delete * @memberOf! () * @@ -56800,7 +56934,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.get - * @desc Returns the specified regional HealthCheckService resource. + * @desc Returns the specified regional HealthCheckService resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthCheckServices.get * @memberOf! () * @@ -56876,7 +57010,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.insert - * @desc Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. + * @desc Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthCheckServices.insert * @memberOf! () * @@ -56953,7 +57087,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.list - * @desc Lists all the HealthCheckService resources that have been configured for the specified project in the given region. + * @desc Lists all the HealthCheckService resources that have been configured for the specified project in the given region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthCheckServices.list * @memberOf! () * @@ -57034,7 +57168,7 @@ export namespace compute_alpha { /** * compute.regionHealthCheckServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthCheckServices.testIamPermissions * @memberOf! () * @@ -57249,7 +57383,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.abandonInstances * @memberOf! () * @@ -57327,7 +57461,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.applyUpdatesToInstances - * @desc Apply updates to selected instances the managed instance group. + * @desc Apply updates to selected instances the managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -57406,7 +57540,7 @@ export namespace compute_alpha { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.createInstances * @memberOf! () * @@ -57484,7 +57618,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. + * @desc Deletes the specified managed instance group and all of the instances in that group. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.delete * @memberOf! () * @@ -57561,7 +57695,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.deleteInstances * @memberOf! () * @@ -57639,7 +57773,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.deletePerInstanceConfigs - * @desc Deletes selected per-instance configs for the managed instance group. + * @desc Deletes selected per-instance configs for the managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.deletePerInstanceConfigs * @memberOf! () * @@ -57718,7 +57852,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. + * @desc Returns all of the details about the specified managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.get * @memberOf! () * @@ -57796,7 +57930,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.insert * @memberOf! () * @@ -57873,7 +58007,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained within the specified region. + * @desc Retrieves the list of managed instance groups that are contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.list * @memberOf! () * @@ -57961,7 +58095,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.listErrors - * @desc Lists all errors thrown by actions on instances for a given regional managed instance group. + * @desc Lists all errors thrown by actions on instances for a given regional managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.listErrors * @memberOf! () * @@ -58066,7 +58200,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.listManagedInstances * @memberOf! () * @@ -58170,7 +58304,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.listPerInstanceConfigs - * @desc Lists all of the per-instance configs defined for the managed instance group. + * @desc Lists all of the per-instance configs defined for the managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.listPerInstanceConfigs * @memberOf! () * @@ -58274,7 +58408,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.patch * @memberOf! () * @@ -58352,7 +58486,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.patchPerInstanceConfigs - * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. + * @desc Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.patchPerInstanceConfigs * @memberOf! () * @@ -58432,7 +58566,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.recreateInstances * @memberOf! () * @@ -58510,7 +58644,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.resize * @memberOf! () * @@ -58588,7 +58722,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. + * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.setAutoHealingPolicies * @memberOf! () * @@ -58668,7 +58802,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.setInstanceTemplate * @memberOf! () * @@ -58746,7 +58880,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.setTargetPools * @memberOf! () * @@ -58824,7 +58958,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.testIamPermissions * @memberOf! () * @@ -58905,7 +59039,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.update * @memberOf! () * @@ -58983,7 +59117,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroupManagers.updatePerInstanceConfigs - * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. + * @desc Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.updatePerInstanceConfigs * @memberOf! () * @@ -59702,7 +59836,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.get - * @desc Returns the specified instance group resource. + * @desc Returns the specified instance group resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroups.get * @memberOf! () * @@ -59778,7 +59912,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the specified region. + * @desc Retrieves the list of instance group resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroups.list * @memberOf! () * @@ -59859,7 +59993,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroups.listInstances * @memberOf! () * @@ -59949,7 +60083,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.setNamedPorts - * @desc Sets the named ports for the specified regional instance group. + * @desc Sets the named ports for the specified regional instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroups.setNamedPorts * @memberOf! () * @@ -60027,7 +60161,7 @@ export namespace compute_alpha { /** * compute.regionInstanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroups.testIamPermissions * @memberOf! () * @@ -60263,7 +60397,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.delete - * @desc Deletes the specified NotificationEndpoint in the given region + * @desc Deletes the specified NotificationEndpoint in the given region (== suppress_warning http-rest-shadowed ==) * @alias compute.regionNotificationEndpoints.delete * @memberOf! () * @@ -60340,7 +60474,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.get - * @desc Returns the specified NotificationEndpoint resource in the given region. + * @desc Returns the specified NotificationEndpoint resource in the given region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionNotificationEndpoints.get * @memberOf! () * @@ -60418,7 +60552,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.insert - * @desc Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. + * @desc Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionNotificationEndpoints.insert * @memberOf! () * @@ -60495,7 +60629,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.list - * @desc Lists the NotificationEndpoints for a project in the given region. + * @desc Lists the NotificationEndpoints for a project in the given region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionNotificationEndpoints.list * @memberOf! () * @@ -60576,7 +60710,7 @@ export namespace compute_alpha { /** * compute.regionNotificationEndpoints.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionNotificationEndpoints.testIamPermissions * @memberOf! () * @@ -60791,7 +60925,7 @@ export namespace compute_alpha { /** * compute.regionOperations.delete - * @desc Deletes the specified region-specific Operations resource. + * @desc Deletes the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionOperations.delete * @memberOf! () * @@ -60865,7 +60999,7 @@ export namespace compute_alpha { /** * compute.regionOperations.get - * @desc Retrieves the specified region-specific Operations resource. + * @desc Retrieves the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionOperations.get * @memberOf! () * @@ -60941,7 +61075,7 @@ export namespace compute_alpha { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the specified region. + * @desc Retrieves a list of Operation resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionOperations.list * @memberOf! () * @@ -61020,7 +61154,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 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. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionOperations.wait * @memberOf! () * @@ -61196,7 +61330,7 @@ export namespace compute_alpha { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regions.get * @memberOf! () * @@ -61267,7 +61401,7 @@ export namespace compute_alpha { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified project. + * @desc Retrieves the list of region resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.regions.list * @memberOf! () * @@ -61393,7 +61527,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.delete - * @desc Deletes the specified SslCertificate resource in the region. + * @desc Deletes the specified SslCertificate resource in the region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.delete * @memberOf! () * @@ -61470,7 +61604,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.get - * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.get * @memberOf! () * @@ -61546,7 +61680,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.insert * @memberOf! () * @@ -61623,7 +61757,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.list * @memberOf! () * @@ -61702,7 +61836,7 @@ export namespace compute_alpha { /** * compute.regionSslCertificates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource and region. + * @desc Returns permissions that a caller has on the specified resource and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.testIamPermissions * @memberOf! () * @@ -61917,7 +62051,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. + * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.delete * @memberOf! () * @@ -61994,7 +62128,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.get * @memberOf! () * @@ -62070,7 +62204,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.insert * @memberOf! () * @@ -62147,7 +62281,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.list * @memberOf! () * @@ -62226,7 +62360,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. + * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.setUrlMap * @memberOf! () * @@ -62304,7 +62438,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.testIamPermissions * @memberOf! () * @@ -62548,7 +62682,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. + * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.delete * @memberOf! () * @@ -62625,7 +62759,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.get * @memberOf! () * @@ -62701,7 +62835,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.insert * @memberOf! () * @@ -62778,7 +62912,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.list * @memberOf! () * @@ -62859,7 +62993,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. + * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.setSslCertificates * @memberOf! () * @@ -62937,7 +63071,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. + * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.setUrlMap * @memberOf! () * @@ -63015,7 +63149,7 @@ export namespace compute_alpha { /** * compute.regionTargetHttpsProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.testIamPermissions * @memberOf! () * @@ -63288,7 +63422,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.delete - * @desc Deletes the specified UrlMap resource. + * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.delete * @memberOf! () * @@ -63365,7 +63499,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.get * @memberOf! () * @@ -63439,7 +63573,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.insert * @memberOf! () * @@ -63516,7 +63650,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.invalidateCache * @memberOf! () * @@ -63594,7 +63728,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.list * @memberOf! () * @@ -63673,7 +63807,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.patch * @memberOf! () * @@ -63751,7 +63885,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.testIamPermissions * @memberOf! () * @@ -63832,7 +63966,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. + * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.update * @memberOf! () * @@ -63910,7 +64044,7 @@ export namespace compute_alpha { /** * compute.regionUrlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.validate * @memberOf! () * @@ -64237,7 +64371,7 @@ export namespace compute_alpha { /** * compute.reservations.aggregatedList - * @desc Retrieves an aggregated list of reservations. + * @desc Retrieves an aggregated list of reservations. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.aggregatedList * @memberOf! () * @@ -64322,7 +64456,7 @@ export namespace compute_alpha { /** * compute.reservations.delete - * @desc Deletes the specified reservation. + * @desc Deletes the specified reservation. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.delete * @memberOf! () * @@ -64399,7 +64533,7 @@ export namespace compute_alpha { /** * compute.reservations.get - * @desc Retrieves information about the specified reservation. + * @desc Retrieves information about the specified reservation. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.get * @memberOf! () * @@ -64474,7 +64608,7 @@ export namespace compute_alpha { /** * compute.reservations.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.getIamPolicy * @memberOf! () * @@ -64549,7 +64683,7 @@ export namespace compute_alpha { /** * compute.reservations.insert - * @desc Creates a new reservation. For more information, read Reserving zonal resources. + * @desc Creates a new reservation. For more information, read Reserving zonal resources. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.insert * @memberOf! () * @@ -64626,7 +64760,7 @@ export namespace compute_alpha { /** * compute.reservations.list - * @desc A list of all the reservations that have been configured for the specified project in specified zone. + * @desc A list of all the reservations that have been configured for the specified project in specified zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.list * @memberOf! () * @@ -64705,7 +64839,7 @@ export namespace compute_alpha { /** * compute.reservations.resize - * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. + * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.resize * @memberOf! () * @@ -64783,7 +64917,7 @@ export namespace compute_alpha { /** * compute.reservations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.setIamPolicy * @memberOf! () * @@ -64858,7 +64992,7 @@ export namespace compute_alpha { /** * compute.reservations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.testIamPermissions * @memberOf! () * @@ -65178,7 +65312,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.aggregatedList - * @desc Retrieves an aggregated list of resource policies. + * @desc Retrieves an aggregated list of resource policies. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.aggregatedList * @memberOf! () * @@ -65265,7 +65399,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.delete - * @desc Deletes the specified resource policy. + * @desc Deletes the specified resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.delete * @memberOf! () * @@ -65342,7 +65476,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.get - * @desc Retrieves all information of the specified resource policy. + * @desc Retrieves all information of the specified resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.get * @memberOf! () * @@ -65418,7 +65552,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.getIamPolicy * @memberOf! () * @@ -65493,7 +65627,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.insert - * @desc Creates a new resource policy. + * @desc Creates a new resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.insert * @memberOf! () * @@ -65570,7 +65704,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.list - * @desc A list all the resource policies that have been configured for the specified project in specified region. + * @desc A list all the resource policies that have been configured for the specified project in specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.list * @memberOf! () * @@ -65649,7 +65783,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.setIamPolicy * @memberOf! () * @@ -65724,7 +65858,7 @@ export namespace compute_alpha { /** * compute.resourcePolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.testIamPermissions * @memberOf! () * @@ -66016,7 +66150,7 @@ export namespace compute_alpha { /** * compute.routers.aggregatedList - * @desc Retrieves an aggregated list of routers. + * @desc Retrieves an aggregated list of routers. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.aggregatedList * @memberOf! () * @@ -66097,7 +66231,7 @@ export namespace compute_alpha { /** * compute.routers.delete - * @desc Deletes the specified Router resource. + * @desc Deletes the specified Router resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.delete * @memberOf! () * @@ -66173,7 +66307,7 @@ export namespace compute_alpha { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.get * @memberOf! () * @@ -66246,7 +66380,7 @@ export namespace compute_alpha { /** * compute.routers.getNatMappingInfo - * @desc Retrieves runtime Nat mapping information of VM endpoints. + * @desc Retrieves runtime Nat mapping information of VM endpoints. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.getNatMappingInfo * @memberOf! () * @@ -66334,7 +66468,7 @@ export namespace compute_alpha { /** * compute.routers.getRouterStatus - * @desc Retrieves runtime information of the specified router. + * @desc Retrieves runtime information of the specified router. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.getRouterStatus * @memberOf! () * @@ -66414,7 +66548,7 @@ export namespace compute_alpha { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using the data included in the request. + * @desc Creates a Router resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.insert * @memberOf! () * @@ -66490,7 +66624,7 @@ export namespace compute_alpha { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified project. + * @desc Retrieves a list of Router resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.list * @memberOf! () * @@ -66568,7 +66702,7 @@ export namespace compute_alpha { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.patch * @memberOf! () * @@ -66645,7 +66779,7 @@ export namespace compute_alpha { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.preview * @memberOf! () * @@ -66725,7 +66859,7 @@ export namespace compute_alpha { /** * compute.routers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.testIamPermissions * @memberOf! () * @@ -66806,7 +66940,7 @@ export namespace compute_alpha { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.update * @memberOf! () * @@ -67181,7 +67315,7 @@ export namespace compute_alpha { /** * compute.routes.delete - * @desc Deletes the specified Route resource. + * @desc Deletes the specified Route resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.routes.delete * @memberOf! () * @@ -67256,7 +67390,7 @@ export namespace compute_alpha { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.routes.get * @memberOf! () * @@ -67328,7 +67462,7 @@ export namespace compute_alpha { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data included in the request. + * @desc Creates a Route resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.routes.insert * @memberOf! () * @@ -67402,7 +67536,7 @@ export namespace compute_alpha { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified project. + * @desc Retrieves the list of Route resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.routes.list * @memberOf! () * @@ -67478,7 +67612,7 @@ export namespace compute_alpha { /** * compute.routes.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.routes.testIamPermissions * @memberOf! () * @@ -67668,7 +67802,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.addRule - * @desc Inserts a rule into a security policy. + * @desc Inserts a rule into a security policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.addRule * @memberOf! () * @@ -67745,7 +67879,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.delete - * @desc Deletes the specified policy. + * @desc Deletes the specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.delete * @memberOf! () * @@ -67821,7 +67955,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.get - * @desc List all of the ordered rules present in a single specified policy. + * @desc List all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.get * @memberOf! () * @@ -67896,7 +68030,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.getRule - * @desc Gets a rule at the specified priority. + * @desc Gets a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.getRule * @memberOf! () * @@ -67972,7 +68106,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data included in the request. + * @desc Creates a new policy in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.insert * @memberOf! () * @@ -68049,7 +68183,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified project. + * @desc List all the policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.list * @memberOf! () * @@ -68127,7 +68261,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.listPreconfiguredExpressionSets - * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. + * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.listPreconfiguredExpressionSets * @memberOf! () * @@ -68231,7 +68365,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.patch - * @desc Patches the specified policy with the data included in the request. + * @desc Patches the specified policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.patch * @memberOf! () * @@ -68308,7 +68442,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.patchRule - * @desc Patches a rule at the specified priority. + * @desc Patches a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.patchRule * @memberOf! () * @@ -68386,7 +68520,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.removeRule - * @desc Deletes a rule at the specified priority. + * @desc Deletes a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.removeRule * @memberOf! () * @@ -68462,7 +68596,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.setLabels - * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.setLabels * @memberOf! () * @@ -68538,7 +68672,7 @@ export namespace compute_alpha { /** * compute.securityPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.testIamPermissions * @memberOf! () * @@ -68904,7 +69038,7 @@ export namespace compute_alpha { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.delete * @memberOf! () * @@ -68979,7 +69113,7 @@ export namespace compute_alpha { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.get * @memberOf! () * @@ -69051,7 +69185,7 @@ export namespace compute_alpha { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -69125,7 +69259,7 @@ export namespace compute_alpha { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the specified project. + * @desc Retrieves the list of Snapshot resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.list * @memberOf! () * @@ -69201,7 +69335,7 @@ export namespace compute_alpha { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -69275,7 +69409,7 @@ export namespace compute_alpha { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.setLabels * @memberOf! () * @@ -69351,7 +69485,7 @@ export namespace compute_alpha { /** * compute.snapshots.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.testIamPermissions * @memberOf! () * @@ -69583,7 +69717,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.aggregatedList - * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. + * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslCertificates.aggregatedList * @memberOf! () * @@ -69670,7 +69804,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.delete - * @desc Deletes the specified SslCertificate resource. + * @desc Deletes the specified SslCertificate resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslCertificates.delete * @memberOf! () * @@ -69746,7 +69880,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslCertificates.get * @memberOf! () * @@ -69821,7 +69955,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using the data included in the request. + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslCertificates.insert * @memberOf! () * @@ -69897,7 +70031,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project. + * @desc Retrieves the list of SslCertificate resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslCertificates.list * @memberOf! () * @@ -69975,7 +70109,7 @@ export namespace compute_alpha { /** * compute.sslCertificates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslCertificates.testIamPermissions * @memberOf! () * @@ -70197,7 +70331,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.delete * @memberOf! () * @@ -70273,7 +70407,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified policy. + * @desc Lists all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.get * @memberOf! () * @@ -70347,7 +70481,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.insert * @memberOf! () * @@ -70422,7 +70556,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the specified project. + * @desc Lists all the SSL policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.list * @memberOf! () * @@ -70498,7 +70632,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when using custom profile. + * @desc Lists all features that can be specified in the SSL policy when using custom profile. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -70593,7 +70727,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the request. + * @desc Patches the specified SSL policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.patch * @memberOf! () * @@ -70670,7 +70804,7 @@ export namespace compute_alpha { /** * compute.sslPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.testIamPermissions * @memberOf! () * @@ -70915,7 +71049,7 @@ export namespace compute_alpha { /** * compute.subnetworks.aggregatedList - * @desc Retrieves an aggregated list of subnetworks. + * @desc Retrieves an aggregated list of subnetworks. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.aggregatedList * @memberOf! () * @@ -70997,7 +71131,7 @@ export namespace compute_alpha { /** * compute.subnetworks.delete - * @desc Deletes the specified subnetwork. + * @desc Deletes the specified subnetwork. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.delete * @memberOf! () * @@ -71074,7 +71208,7 @@ export namespace compute_alpha { /** * compute.subnetworks.expandIpCidrRange - * @desc Expands the IP CIDR range of the subnetwork to a specified value. + * @desc Expands the IP CIDR range of the subnetwork to a specified value. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.expandIpCidrRange * @memberOf! () * @@ -71152,7 +71286,7 @@ export namespace compute_alpha { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.get * @memberOf! () * @@ -71227,7 +71361,7 @@ export namespace compute_alpha { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.getIamPolicy * @memberOf! () * @@ -71302,7 +71436,7 @@ export namespace compute_alpha { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data included in the request. + * @desc Creates a subnetwork in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.insert * @memberOf! () * @@ -71379,7 +71513,7 @@ export namespace compute_alpha { /** * compute.subnetworks.list - * @desc Retrieves a list of subnetworks available to the specified project. + * @desc Retrieves a list of subnetworks available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.list * @memberOf! () * @@ -71457,7 +71591,7 @@ export namespace compute_alpha { /** * compute.subnetworks.listUsable - * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. + * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.listUsable * @memberOf! () * @@ -71544,7 +71678,7 @@ export namespace compute_alpha { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.patch * @memberOf! () * @@ -71623,7 +71757,7 @@ export namespace compute_alpha { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.setIamPolicy * @memberOf! () * @@ -71698,7 +71832,7 @@ export namespace compute_alpha { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.setPrivateIpGoogleAccess * @memberOf! () * @@ -71778,7 +71912,7 @@ export namespace compute_alpha { /** * compute.subnetworks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.testIamPermissions * @memberOf! () * @@ -72187,7 +72321,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. + * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.aggregatedList * @memberOf! () * @@ -72274,7 +72408,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. + * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.delete * @memberOf! () * @@ -72350,7 +72484,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.get * @memberOf! () * @@ -72425,7 +72559,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.insert * @memberOf! () * @@ -72501,7 +72635,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.list * @memberOf! () * @@ -72579,7 +72713,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. + * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.setUrlMap * @memberOf! () * @@ -72656,7 +72790,7 @@ export namespace compute_alpha { /** * compute.targetHttpProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.testIamPermissions * @memberOf! () * @@ -72903,7 +73037,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. + * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.aggregatedList * @memberOf! () * @@ -72990,7 +73124,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. + * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.delete * @memberOf! () * @@ -73066,7 +73200,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.get * @memberOf! () * @@ -73141,7 +73275,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.insert * @memberOf! () * @@ -73217,7 +73351,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.list * @memberOf! () * @@ -73297,7 +73431,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setQuicOverride - * @desc Sets the QUIC override policy for TargetHttpsProxy. + * @desc Sets the QUIC override policy for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.setQuicOverride * @memberOf! () * @@ -73374,7 +73508,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. + * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.setSslCertificates * @memberOf! () * @@ -73451,7 +73585,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -73528,7 +73662,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. + * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.setUrlMap * @memberOf! () * @@ -73605,7 +73739,7 @@ export namespace compute_alpha { /** * compute.targetHttpsProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.testIamPermissions * @memberOf! () * @@ -73927,7 +74061,7 @@ export namespace compute_alpha { /** * compute.targetInstances.aggregatedList - * @desc Retrieves an aggregated list of target instances. + * @desc Retrieves an aggregated list of target instances. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetInstances.aggregatedList * @memberOf! () * @@ -74014,7 +74148,7 @@ export namespace compute_alpha { /** * compute.targetInstances.delete - * @desc Deletes the specified TargetInstance resource. + * @desc Deletes the specified TargetInstance resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetInstances.delete * @memberOf! () * @@ -74091,7 +74225,7 @@ export namespace compute_alpha { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetInstances.get * @memberOf! () * @@ -74167,7 +74301,7 @@ export namespace compute_alpha { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetInstances.insert * @memberOf! () * @@ -74244,7 +74378,7 @@ export namespace compute_alpha { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetInstances.list * @memberOf! () * @@ -74323,7 +74457,7 @@ export namespace compute_alpha { /** * compute.targetInstances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetInstances.testIamPermissions * @memberOf! () * @@ -74566,7 +74700,7 @@ export namespace compute_alpha { /** * compute.targetPools.addHealthCheck - * @desc Adds health check URLs to a target pool. + * @desc Adds health check URLs to a target pool. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.addHealthCheck * @memberOf! () * @@ -74644,7 +74778,7 @@ export namespace compute_alpha { /** * compute.targetPools.addInstance - * @desc Adds an instance to a target pool. + * @desc Adds an instance to a target pool. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.addInstance * @memberOf! () * @@ -74722,7 +74856,7 @@ export namespace compute_alpha { /** * compute.targetPools.aggregatedList - * @desc Retrieves an aggregated list of target pools. + * @desc Retrieves an aggregated list of target pools. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.aggregatedList * @memberOf! () * @@ -74804,7 +74938,7 @@ export namespace compute_alpha { /** * compute.targetPools.delete - * @desc Deletes the specified target pool. + * @desc Deletes the specified target pool. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.delete * @memberOf! () * @@ -74881,7 +75015,7 @@ export namespace compute_alpha { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.get * @memberOf! () * @@ -74956,7 +75090,7 @@ export namespace compute_alpha { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.getHealth * @memberOf! () * @@ -75037,7 +75171,7 @@ export namespace compute_alpha { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the data included in the request. + * @desc Creates a target pool in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.insert * @memberOf! () * @@ -75114,7 +75248,7 @@ export namespace compute_alpha { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project and region. + * @desc Retrieves a list of target pools available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.list * @memberOf! () * @@ -75192,7 +75326,7 @@ export namespace compute_alpha { /** * compute.targetPools.removeHealthCheck - * @desc Removes health check URL from a target pool. + * @desc Removes health check URL from a target pool. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.removeHealthCheck * @memberOf! () * @@ -75270,7 +75404,7 @@ export namespace compute_alpha { /** * compute.targetPools.removeInstance - * @desc Removes instance URL from a target pool. + * @desc Removes instance URL from a target pool. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.removeInstance * @memberOf! () * @@ -75348,7 +75482,7 @@ export namespace compute_alpha { /** * compute.targetPools.setBackup - * @desc Changes a backup target pool's configurations. + * @desc Changes a backup target pool's configurations. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.setBackup * @memberOf! () * @@ -75427,7 +75561,7 @@ export namespace compute_alpha { /** * compute.targetPools.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetPools.testIamPermissions * @memberOf! () * @@ -75842,7 +75976,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.delete - * @desc Deletes the specified TargetSslProxy resource. + * @desc Deletes the specified TargetSslProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.delete * @memberOf! () * @@ -75918,7 +76052,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.get * @memberOf! () * @@ -75993,7 +76127,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.insert * @memberOf! () * @@ -76069,7 +76203,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the specified project. + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.list * @memberOf! () * @@ -76147,7 +76281,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setBackendService - * @desc Changes the BackendService for TargetSslProxy. + * @desc Changes the BackendService for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.setBackendService * @memberOf! () * @@ -76224,7 +76358,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetSslProxy. + * @desc Changes the ProxyHeaderType for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.setProxyHeader * @memberOf! () * @@ -76301,7 +76435,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setSslCertificates - * @desc Changes SslCertificates for TargetSslProxy. + * @desc Changes SslCertificates for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.setSslCertificates * @memberOf! () * @@ -76378,7 +76512,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -76455,7 +76589,7 @@ export namespace compute_alpha { /** * compute.targetSslProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.testIamPermissions * @memberOf! () * @@ -76749,7 +76883,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.delete - * @desc Deletes the specified TargetTcpProxy resource. + * @desc Deletes the specified TargetTcpProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetTcpProxies.delete * @memberOf! () * @@ -76825,7 +76959,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetTcpProxies.get * @memberOf! () * @@ -76900,7 +77034,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetTcpProxies.insert * @memberOf! () * @@ -76976,7 +77110,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetTcpProxies.list * @memberOf! () * @@ -77054,7 +77188,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.setBackendService - * @desc Changes the BackendService for TargetTcpProxy. + * @desc Changes the BackendService for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetTcpProxies.setBackendService * @memberOf! () * @@ -77131,7 +77265,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetTcpProxy. + * @desc Changes the ProxyHeaderType for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetTcpProxies.setProxyHeader * @memberOf! () * @@ -77208,7 +77342,7 @@ export namespace compute_alpha { /** * compute.targetTcpProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetTcpProxies.testIamPermissions * @memberOf! () * @@ -77452,7 +77586,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.aggregatedList - * @desc Retrieves an aggregated list of target VPN gateways. + * @desc Retrieves an aggregated list of target VPN gateways. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetVpnGateways.aggregatedList * @memberOf! () * @@ -77539,7 +77673,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.delete - * @desc Deletes the specified target VPN gateway. + * @desc Deletes the specified target VPN gateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetVpnGateways.delete * @memberOf! () * @@ -77616,7 +77750,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetVpnGateways.get * @memberOf! () * @@ -77692,7 +77826,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetVpnGateways.insert * @memberOf! () * @@ -77769,7 +77903,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified project and region. + * @desc Retrieves a list of target VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetVpnGateways.list * @memberOf! () * @@ -77850,7 +77984,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.setLabels - * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetVpnGateways.setLabels * @memberOf! () * @@ -77928,7 +78062,7 @@ export namespace compute_alpha { /** * compute.targetVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetVpnGateways.testIamPermissions * @memberOf! () * @@ -78200,7 +78334,7 @@ export namespace compute_alpha { /** * compute.urlMaps.aggregatedList - * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. + * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.aggregatedList * @memberOf! () * @@ -78281,7 +78415,7 @@ export namespace compute_alpha { /** * compute.urlMaps.delete - * @desc Deletes the specified UrlMap resource. + * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.delete * @memberOf! () * @@ -78356,7 +78490,7 @@ export namespace compute_alpha { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.get * @memberOf! () * @@ -78428,7 +78562,7 @@ export namespace compute_alpha { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.insert * @memberOf! () * @@ -78502,7 +78636,7 @@ export namespace compute_alpha { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.invalidateCache * @memberOf! () * @@ -78579,7 +78713,7 @@ export namespace compute_alpha { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project. + * @desc Retrieves the list of UrlMap resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.list * @memberOf! () * @@ -78655,7 +78789,7 @@ export namespace compute_alpha { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.patch * @memberOf! () * @@ -78731,7 +78865,7 @@ export namespace compute_alpha { /** * compute.urlMaps.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.testIamPermissions * @memberOf! () * @@ -78811,7 +78945,7 @@ export namespace compute_alpha { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. + * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.update * @memberOf! () * @@ -78887,7 +79021,7 @@ export namespace compute_alpha { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.validate * @memberOf! () * @@ -79197,7 +79331,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.aggregatedList - * @desc Retrieves an aggregated list of VPN gateways. + * @desc Retrieves an aggregated list of VPN gateways. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.aggregatedList * @memberOf! () * @@ -79279,7 +79413,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.delete - * @desc Deletes the specified VPN gateway. + * @desc Deletes the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.delete * @memberOf! () * @@ -79356,7 +79490,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.get - * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.get * @memberOf! () * @@ -79431,7 +79565,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.getStatus - * @desc Returns the status for the specified VPN gateway. + * @desc Returns the status for the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.getStatus * @memberOf! () * @@ -79516,7 +79650,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.insert - * @desc Creates a VPN gateway in the specified project and region using the data included in the request. + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.insert * @memberOf! () * @@ -79593,7 +79727,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.list - * @desc Retrieves a list of VPN gateways available to the specified project and region. + * @desc Retrieves a list of VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.list * @memberOf! () * @@ -79671,7 +79805,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.setLabels - * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.setLabels * @memberOf! () * @@ -79749,7 +79883,7 @@ export namespace compute_alpha { /** * compute.vpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.testIamPermissions * @memberOf! () * @@ -80039,7 +80173,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.aggregatedList - * @desc Retrieves an aggregated list of VPN tunnels. + * @desc Retrieves an aggregated list of VPN tunnels. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnTunnels.aggregatedList * @memberOf! () * @@ -80121,7 +80255,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.delete - * @desc Deletes the specified VpnTunnel resource. + * @desc Deletes the specified VpnTunnel resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnTunnels.delete * @memberOf! () * @@ -80198,7 +80332,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnTunnels.get * @memberOf! () * @@ -80273,7 +80407,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnTunnels.insert * @memberOf! () * @@ -80350,7 +80484,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnTunnels.list * @memberOf! () * @@ -80428,7 +80562,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.setLabels - * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnTunnels.setLabels * @memberOf! () * @@ -80506,7 +80640,7 @@ export namespace compute_alpha { /** * compute.vpnTunnels.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnTunnels.testIamPermissions * @memberOf! () * @@ -80776,7 +80910,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.delete - * @desc Deletes the specified zone-specific Operations resource. + * @desc Deletes the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.zoneOperations.delete * @memberOf! () * @@ -80850,7 +80984,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.get - * @desc Retrieves the specified zone-specific Operations resource. + * @desc Retrieves the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.zoneOperations.get * @memberOf! () * @@ -80926,7 +81060,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the specified zone. + * @desc Retrieves a list of Operation resources contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.zoneOperations.list * @memberOf! () * @@ -81005,7 +81139,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 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. (== suppress_warning http-rest-shadowed ==) * @alias compute.zoneOperations.wait * @memberOf! () * @@ -81181,7 +81315,7 @@ export namespace compute_alpha { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.zones.get * @memberOf! () * @@ -81252,7 +81386,7 @@ export namespace compute_alpha { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified project. + * @desc Retrieves the list of Zone resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.zones.list * @memberOf! () * diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 58e9019aafa..8ccaa285a08 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -121,6 +121,7 @@ export namespace compute_beta { nodeGroups: Resource$Nodegroups; nodeTemplates: Resource$Nodetemplates; nodeTypes: Resource$Nodetypes; + packetMirrorings: Resource$Packetmirrorings; projects: Resource$Projects; regionAutoscalers: Resource$Regionautoscalers; regionBackendServices: Resource$Regionbackendservices; @@ -206,6 +207,7 @@ export namespace compute_beta { 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( @@ -768,9 +770,6 @@ export namespace compute_beta { * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[] | null; - /** - * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. - */ ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. @@ -814,6 +813,10 @@ export namespace compute_beta { * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction. + */ + recommendedSize?: number | null; /** * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). */ @@ -954,6 +957,10 @@ export namespace compute_beta { * The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. */ minNumReplicas?: number | null; + /** + * Defines operating mode for this policy. + */ + mode?: string | null; } /** * CPU utilization policy. @@ -1139,7 +1146,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * 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 ==) */ export interface Schema$BackendService { /** @@ -1155,7 +1162,7 @@ export namespace compute_beta { */ cdnPolicy?: Schema$BackendServiceCdnPolicy; /** - * Settings controlling the volume of connections to a backend service. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * Settings controlling the volume of connections to a 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. */ circuitBreakers?: Schema$CircuitBreakers; connectionDraining?: Schema$ConnectionDraining; @@ -1201,7 +1208,7 @@ export namespace compute_beta { */ kind?: string | null; /** - * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. + * Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer. */ loadBalancingScheme?: string | null; /** @@ -1221,7 +1228,7 @@ export namespace compute_beta { */ network?: string | null; /** - * Settings controlling eviction of unhealthy hosts from the load balancing pool. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + * 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. */ outlierDetection?: Schema$OutlierDetection; /** @@ -1233,7 +1240,7 @@ export namespace compute_beta { */ portName?: string | null; /** - * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information. */ protocol?: string | null; /** @@ -1593,23 +1600,23 @@ export namespace compute_beta { */ connectTimeout?: Schema$Duration; /** - * The maximum number of connections to the backend cluster. If not specified, the default is 1024. + * The maximum number of connections to the backend service. If not specified, there is no limit. */ maxConnections?: number | null; /** - * The maximum number of pending requests allowed to the backend cluster. If not specified, the default is 1024. + * The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. */ maxPendingRequests?: number | null; /** - * The maximum number of parallel requests that allowed to the backend cluster. If not specified, the default is 1024. + * The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit. */ maxRequests?: number | null; /** - * Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. + * Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. */ maxRequestsPerConnection?: number | null; /** - * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 3. + * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. */ maxRetries?: number | null; } @@ -1868,6 +1875,10 @@ export namespace compute_beta { * The name of the encryption key that is stored in Google Cloud KMS. */ kmsKeyName?: string | null; + /** + * The service account being used for the encryption request for the given KMS key. If absent, default GCE compute robot account will be used + */ + kmsKeyServiceAccount?: string | null; /** * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. */ @@ -2141,7 +2152,7 @@ export namespace compute_beta { } export interface Schema$DisksAddResourcePoliciesRequest { /** - * Resource policies to be added to this disk. + * Resource policies to be added to this disk. Currently you can only specify one policy here. */ resourcePolicies?: string[] | null; } @@ -2641,7 +2652,7 @@ export namespace compute_beta { percent?: number | null; } /** - * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * 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 ==) */ export interface Schema$ForwardingRule { /** @@ -2677,13 +2688,17 @@ export namespace compute_beta { */ IPAddress?: string | null; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. + * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. */ IPProtocol?: string | null; /** * 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. */ @@ -2697,7 +2712,7 @@ export namespace compute_beta { */ labels?: {[key: string]: string} | null; /** - * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + * 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; /** @@ -3252,6 +3267,36 @@ export namespace compute_beta { */ replace?: boolean | null; } + export interface Schema$HTTPHealthCheck { + /** + * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The request path of the HTTP health check request. The default value is /. + */ + requestPath?: string | null; + /** + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + */ + response?: string | null; + } /** * Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. */ @@ -3309,36 +3354,6 @@ export namespace compute_beta { */ unhealthyThreshold?: number | null; } - export interface Schema$HTTPHealthCheck { - /** - * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. - */ - host?: string | null; - /** - * The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. - */ - port?: number | null; - /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. - */ - portName?: string | null; - /** - * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. - */ - portSpecification?: string | null; - /** - * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. - */ - proxyHeader?: string | null; - /** - * The request path of the HTTP health check request. The default value is /. - */ - requestPath?: string | null; - /** - * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. - */ - response?: string | null; - } /** * Contains a list of HttpHealthCheck resources. */ @@ -3427,11 +3442,11 @@ export namespace compute_beta { */ export interface Schema$HttpRetryPolicy { /** - * Specifies the allowed number retries. This number must be > 0. + * Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. */ numRetries?: number | null; /** - * Specifies a non-zero timeout per retry attempt. + * Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. */ perTryTimeout?: Schema$Duration; /** @@ -3457,7 +3472,7 @@ export namespace compute_beta { */ retryPolicy?: Schema$HttpRetryPolicy; /** - * Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. + * Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. */ timeout?: Schema$Duration; /** @@ -3473,11 +3488,19 @@ export namespace compute_beta { * An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. */ export interface Schema$HttpRouteRule { + /** + * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. + */ + description?: string | null; /** * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction */ headerAction?: Schema$HttpHeaderAction; matchRules?: Schema$HttpRouteRuleMatch[]; + /** + * For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules. + */ + priority?: number | null; /** * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. */ @@ -3524,6 +3547,36 @@ export namespace compute_beta { */ regexMatch?: string | null; } + export interface Schema$HTTPSHealthCheck { + /** + * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + */ + port?: number | null; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + */ + portName?: string | null; + /** + * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. + */ + portSpecification?: string | null; + /** + * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string | null; + /** + * The request path of the HTTPS health check request. The default value is /. + */ + requestPath?: string | null; + /** + * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + */ + response?: string | null; + } /** * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. */ @@ -3581,206 +3634,176 @@ export namespace compute_beta { */ unhealthyThreshold?: number | null; } - export interface Schema$HTTPSHealthCheck { + /** + * Contains a list of HttpsHealthCheck resources. + */ + export interface Schema$HttpsHealthCheckList { /** - * The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. + * [Output Only] Unique identifier for the resource; defined by the server. */ - host?: string | null; + id?: string | null; /** - * The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. + * A list of HttpsHealthCheck resources. */ - port?: number | null; + items?: Schema$HttpsHealthCheck[]; /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. + * Type of resource. */ - portName?: string | null; + kind?: string | null; /** - * Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. + * [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. */ - portSpecification?: string | null; + nextPageToken?: string | null; /** - * Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. + * [Output Only] Server-defined URL for this resource. */ - proxyHeader?: string | null; + selfLink?: string | null; /** - * The request path of the HTTPS health check request. The default value is /. + * [Output Only] Informational warning message. */ - requestPath?: string | null; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | 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 ==) + */ + export interface Schema$Image { /** - * The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. + * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). */ - response?: string | null; + archiveSizeBytes?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * The deprecation status associated with this image. + */ + deprecated?: Schema$DeprecationStatus; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Size of the image when restored onto a persistent disk (in GB). + */ + diskSizeGb?: string | null; + /** + * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. + */ + family?: string | 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. + */ + guestOsFeatures?: Schema$GuestOsFeature[]; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. + */ + imageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] Type of the resource. Always compute#image for images. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. + */ + labelFingerprint?: string | null; + /** + * Labels to apply to this image. These can be later modified by the setLabels method. + */ + labels?: {[key: string]: string} | null; + /** + * Integer license codes indicating which licenses are attached to this image. + */ + licenseCodes?: string[] | null; + /** + * Any applicable license URI. + */ + licenses?: 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; + /** + * The parameters of the raw disk image. + */ + rawDisk?: { + containerType?: string; + sha1Checksum?: string; + source?: string; + } | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + */ + sourceDisk?: string | null; + /** + * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. + */ + sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. + */ + sourceDiskId?: string | null; + /** + * URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. + */ + sourceImage?: string | null; + /** + * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. + */ + sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. + */ + sourceImageId?: string | null; + /** + * URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. + */ + sourceSnapshot?: string | null; + /** + * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. + */ + sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. + */ + sourceSnapshotId?: string | null; + /** + * The type of the image used to create this disk. The default and only value is RAW + */ + sourceType?: string | null; + /** + * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. + */ + status?: string | null; + /** + * Cloud Storage bucket storage location of the image (regional or multi-regional). + */ + storageLocations?: string[] | null; } /** - * Contains a list of HttpsHealthCheck resources. + * Contains a list of images. */ - export interface Schema$HttpsHealthCheckList { + export interface Schema$ImageList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ id?: string | null; /** - * A list of HttpsHealthCheck resources. + * A list of Image resources. */ - items?: Schema$HttpsHealthCheck[]; - /** - * 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; - } - /** - * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) - */ - export interface Schema$Image { - /** - * Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). - */ - archiveSizeBytes?: string | null; - /** - * [Output Only] Creation timestamp in RFC3339 text format. - */ - creationTimestamp?: string | null; - /** - * The deprecation status associated with this image. - */ - deprecated?: Schema$DeprecationStatus; - /** - * An optional description of this resource. Provide this property when you create the resource. - */ - description?: string | null; - /** - * Size of the image when restored onto a persistent disk (in GB). - */ - diskSizeGb?: string | null; - /** - * The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. - */ - family?: string | 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. - */ - guestOsFeatures?: Schema$GuestOsFeature[]; - /** - * [Output Only] The unique identifier for the resource. This identifier is defined by the server. - */ - id?: string | null; - /** - * Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. - */ - imageEncryptionKey?: Schema$CustomerEncryptionKey; - /** - * [Output Only] Type of the resource. Always compute#image for images. - */ - kind?: string | null; - /** - * A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. - */ - labelFingerprint?: string | null; - /** - * Labels to apply to this image. These can be later modified by the setLabels method. - */ - labels?: {[key: string]: string} | null; - /** - * Integer license codes indicating which licenses are attached to this image. - */ - licenseCodes?: string[] | null; - /** - * Any applicable license URI. - */ - licenses?: 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; - /** - * The parameters of the raw disk image. - */ - rawDisk?: { - containerType?: string; - sha1Checksum?: string; - source?: string; - } | null; - /** - * [Output Only] Server-defined URL for the resource. - */ - selfLink?: string | null; - /** - * URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk - */ - sourceDisk?: string | null; - /** - * The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. - */ - sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; - /** - * [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. - */ - sourceDiskId?: string | null; - /** - * URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. - */ - sourceImage?: string | null; - /** - * The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. - */ - sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; - /** - * [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. - */ - sourceImageId?: string | null; - /** - * URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image. - */ - sourceSnapshot?: string | null; - /** - * The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. - */ - sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; - /** - * [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. - */ - sourceSnapshotId?: string | null; - /** - * The type of the image used to create this disk. The default and only value is RAW - */ - sourceType?: string | null; - /** - * [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. - */ - status?: string | null; - /** - * Cloud Storage bucket storage location of the image (regional or multi-regional). - */ - storageLocations?: string[] | null; - } - /** - * Contains a list of images. - */ - export interface Schema$ImageList { - /** - * [Output Only] Unique identifier for the resource; defined by the server. - */ - id?: string | null; - /** - * A list of Image resources. - */ - items?: Schema$Image[]; + items?: Schema$Image[]; /** * Type of resource. */ @@ -5590,9 +5613,13 @@ export namespace compute_beta { logName?: 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/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). + * 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]} TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields in the same counter. */ export interface Schema$LogConfigCounterOptions { + /** + * Custom fields. + */ + customFields?: Schema$LogConfigCounterOptionsCustomField[]; /** * The field value to attribute. */ @@ -5602,6 +5629,19 @@ export namespace compute_beta { */ 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$LogConfigCounterOptionsCustomField { + /** + * 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 */ @@ -6917,11 +6957,11 @@ export namespace compute_beta { } | null; } /** - * Settings controlling eviction of unhealthy hosts from the load balancing pool. + * Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. */ export interface Schema$OutlierDetection { /** - * The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + * The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. */ baseEjectionTime?: Schema$Duration; /** @@ -6929,15 +6969,15 @@ export namespace compute_beta { */ consecutiveErrors?: number | null; /** - * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5. + * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. */ consecutiveGatewayFailure?: number | null; /** - * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. */ enforcingConsecutiveErrors?: number | null; /** - * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. */ enforcingConsecutiveGatewayFailure?: number | null; /** @@ -6945,11 +6985,11 @@ export namespace compute_beta { */ enforcingSuccessRate?: number | null; /** - * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds. + * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 seconds. */ interval?: Schema$Duration; /** - * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%. + * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. */ maxEjectionPercent?: number | null; /** @@ -6995,299 +7035,500 @@ export namespace compute_beta { type?: 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. - */ - export interface Schema$PathMatcher { - /** - * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. - */ - defaultRouteAction?: Schema$HttpRouteAction; - /** - * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - */ - defaultService?: string | null; - /** - * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. - */ - defaultUrlRedirect?: Schema$HttpRedirectAction; - /** - * An optional description of this resource. Provide this property when you create the resource. - */ - description?: string | null; - /** - * Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap - */ - headerAction?: Schema$HttpHeaderAction; - /** - * The name to which this PathMatcher is referred by the HostRule. - */ - name?: string | null; - /** - * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. - */ - pathRules?: Schema$PathRule[]; - /** - * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Only one of pathRules or routeRules must be set. - */ - routeRules?: Schema$HttpRouteRule[]; - } - /** - * A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. - */ - export interface Schema$PathRule { - /** - * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. - */ - paths?: string[] | null; - /** - * In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. - */ - routeAction?: Schema$HttpRouteAction; - /** - * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. - */ - service?: string | null; - /** - * When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. - */ - urlRedirect?: Schema$HttpRedirectAction; - } - export interface Schema$PerInstanceConfig { - /** - * Fingerprint of this per-instance config. This field may be used in optimistic locking. It will be ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. - */ - fingerprint?: string | null; - /** - * The name of the per-instance config and the corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in a failure. - */ - name?: string | null; - } - /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). - */ - export interface Schema$Policy { - /** - * Specifies cloud audit logging configuration for this policy. - */ - auditConfigs?: Schema$AuditConfig[]; - /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. - */ - bindings?: Schema$Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. - */ - 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[]; - /** - * Deprecated. - */ - version?: number | null; - } - export interface Schema$PreconfiguredWafSet { - /** - * List of entities that are currently supported for WAF rules. - */ - expressionSets?: Schema$WafExpressionSet[]; - } - /** - * 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 PacketMirroring resource. */ - export interface Schema$Project { + export interface Schema$PacketMirroring { /** - * Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. + * 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. */ - commonInstanceMetadata?: Schema$Metadata; + collectorIlb?: Schema$PacketMirroringForwardingRuleInfo; /** * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; /** - * This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. - */ - defaultNetworkTier?: string | null; - /** - * [Output Only] Default service account used by VMs running in this project. - */ - defaultServiceAccount?: string | null; - /** - * An optional textual description of the resource. + * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; /** - * Restricted features enabled for use on this project. + * 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. */ - enabledFeatures?: string[] | null; - /** - * [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. - */ - id?: string | null; - /** - * [Output Only] Type of the resource. Always compute#project for projects. - */ - kind?: string | null; - /** - * The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. - */ - name?: string | null; - /** - * [Output Only] Quotas assigned to this project. - */ - quotas?: Schema$Quota[]; - /** - * [Output Only] Server-defined URL for the resource. - */ - selfLink?: string | null; - /** - * The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. - */ - usageExportLocation?: Schema$UsageExportLocation; - /** - * [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated. - */ - xpnProjectStatus?: string | null; - } - export interface Schema$ProjectsDisableXpnResourceRequest { - /** - * Service resource (a.k.a service project) ID. - */ - xpnResource?: Schema$XpnResourceId; - } - export interface Schema$ProjectsEnableXpnResourceRequest { - /** - * Service resource (a.k.a service project) ID. - */ - xpnResource?: Schema$XpnResourceId; - } - export interface Schema$ProjectsGetXpnResources { - /** - * [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) - */ - 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; - /** - * Service resources (a.k.a service projects) attached to this project as their shared VPC host. - */ - resources?: Schema$XpnResourceId[]; - } - export interface Schema$ProjectsListXpnHostsRequest { - /** - * Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. - */ - organization?: string | null; - } - export interface Schema$ProjectsSetDefaultNetworkTierRequest { - /** - * Default network tier to be set. - */ - networkTier?: string | null; - } - /** - * A quotas entry. - */ - export interface Schema$Quota { - /** - * [Output Only] Quota limit for this metric. - */ - limit?: number | null; + enable?: string | null; /** - * [Output Only] Name of the quota metric. + * Filter for mirrored traffic. If unspecified, all traffic is mirrored. */ - metric?: string | null; + filter?: Schema$PacketMirroringFilter; /** - * [Output Only] Owning resource. This is the resource on which this quota is applied. + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ - owner?: string | null; + id?: string | null; /** - * [Output Only] Current usage of this metric. - */ - usage?: number | null; - } - /** - * Represents a reference to a resource. - */ - export interface Schema$Reference { - /** - * [Output Only] Type of the resource. Always compute#reference for references. + * [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. */ kind?: string | null; /** - * A description of the reference type with no implied semantics. Possible values include: - MEMBER_OF - */ - referenceType?: string | null; - /** - * URL of the resource which refers to the target. - */ - referrer?: string | null; - /** - * URL of the resource to which this reference points. - */ - 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 ==) - */ - export interface Schema$Region { - /** - * [Output Only] Creation timestamp in RFC3339 text format. - */ - creationTimestamp?: string | null; - /** - * [Output Only] The deprecation status associated with this region. - */ - deprecated?: Schema$DeprecationStatus; - /** - * [Output Only] Textual description of the resource. + * 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. */ - description?: string | null; + mirroredResources?: Schema$PacketMirroringMirroredResourceInfo; /** - * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + * 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. */ - id?: string | null; + name?: string | null; /** - * [Output Only] Type of the resource. Always compute#region for regions. + * 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. */ - kind?: string | null; + network?: Schema$PacketMirroringNetworkInfo; /** - * [Output Only] Name of the resource. + * 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. */ - name?: string | null; + priority?: number | null; /** - * [Output Only] Quotas assigned to this region. + * [Output Only] URI of the region where the packetMirroring resides. */ - quotas?: Schema$Quota[]; + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; - /** - * [Output Only] Status of the region, either UP or DOWN. - */ - status?: string | null; - /** - * [Output Only] A list of zones available in this region, in the form of resource URLs. - */ - zones?: string[] | null; } /** - * Contains a list of autoscalers. + * Contains a list of packetMirrorings. */ - export interface Schema$RegionAutoscalerList { + export interface Schema$PacketMirroringAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ id?: string | null; /** - * A list of Autoscaler resources. + * A list of PacketMirroring resources. */ - items?: Schema$Autoscaler[]; + 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. + */ + export interface Schema$PathMatcher { + /** + * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. + */ + defaultRouteAction?: Schema$HttpRouteAction; + /** + * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + */ + defaultService?: string | null; + /** + * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + */ + defaultUrlRedirect?: Schema$HttpRedirectAction; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap + */ + headerAction?: Schema$HttpHeaderAction; + /** + * The name to which this PathMatcher is referred by the HostRule. + */ + name?: string | null; + /** + * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. + */ + pathRules?: Schema$PathRule[]; + /** + * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. + */ + routeRules?: Schema$HttpRouteRule[]; + } + /** + * A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. + */ + export interface Schema$PathRule { + /** + * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. + */ + paths?: string[] | null; + /** + * In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. + */ + routeAction?: Schema$HttpRouteAction; + /** + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. + */ + service?: string | null; + /** + * When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. + */ + urlRedirect?: Schema$HttpRedirectAction; + } + export interface Schema$PerInstanceConfig { + /** + * Fingerprint of this per-instance config. This field may be used in optimistic locking. It will be ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset. + */ + fingerprint?: string | null; + /** + * The name of the per-instance config and the corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in a failure. + */ + name?: string | 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). + */ + 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 when binding is in effect. `bindings` with no members will result in an error. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. 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?: 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. + */ + version?: number | null; + } + export interface Schema$PreconfiguredWafSet { + /** + * List of entities that are currently supported for WAF rules. + */ + expressionSets?: Schema$WafExpressionSet[]; + } + /** + * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) + */ + export interface Schema$Project { + /** + * Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. + */ + commonInstanceMetadata?: Schema$Metadata; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. + */ + defaultNetworkTier?: string | null; + /** + * [Output Only] Default service account used by VMs running in this project. + */ + defaultServiceAccount?: string | null; + /** + * An optional textual description of the resource. + */ + description?: string | null; + /** + * Restricted features enabled for use on this project. + */ + enabledFeatures?: string[] | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#project for projects. + */ + kind?: string | null; + /** + * The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. + */ + name?: string | null; + /** + * [Output Only] Quotas assigned to this project. + */ + quotas?: Schema$Quota[]; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. + */ + usageExportLocation?: Schema$UsageExportLocation; + /** + * [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated. + */ + xpnProjectStatus?: string | null; + } + export interface Schema$ProjectsDisableXpnResourceRequest { + /** + * Service resource (a.k.a service project) ID. + */ + xpnResource?: Schema$XpnResourceId; + } + export interface Schema$ProjectsEnableXpnResourceRequest { + /** + * Service resource (a.k.a service project) ID. + */ + xpnResource?: Schema$XpnResourceId; + } + export interface Schema$ProjectsGetXpnResources { + /** + * [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) + */ + 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; + /** + * Service resources (a.k.a service projects) attached to this project as their shared VPC host. + */ + resources?: Schema$XpnResourceId[]; + } + export interface Schema$ProjectsListXpnHostsRequest { + /** + * Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. + */ + organization?: string | null; + } + export interface Schema$ProjectsSetDefaultNetworkTierRequest { + /** + * Default network tier to be set. + */ + networkTier?: string | null; + } + /** + * A quotas entry. + */ + export interface Schema$Quota { + /** + * [Output Only] Quota limit for this metric. + */ + limit?: number | null; + /** + * [Output Only] Name of the quota metric. + */ + metric?: string | null; + /** + * [Output Only] Owning resource. This is the resource on which this quota is applied. + */ + owner?: string | null; + /** + * [Output Only] Current usage of this metric. + */ + usage?: number | null; + } + /** + * Represents a reference to a resource. + */ + export interface Schema$Reference { + /** + * [Output Only] Type of the resource. Always compute#reference for references. + */ + kind?: string | null; + /** + * A description of the reference type with no implied semantics. Possible values include: - MEMBER_OF + */ + referenceType?: string | null; + /** + * URL of the resource which refers to the target. + */ + referrer?: string | null; + /** + * URL of the resource to which this reference points. + */ + 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 ==) + */ + export interface Schema$Region { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] The deprecation status associated with this region. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] Textual description of the resource. + */ + description?: string | 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#region for regions. + */ + kind?: string | null; + /** + * [Output Only] Name of the resource. + */ + name?: string | null; + /** + * [Output Only] Quotas assigned to this region. + */ + quotas?: Schema$Quota[]; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Status of the region, either UP or DOWN. + */ + status?: string | null; + /** + * [Output Only] A list of zones available in this region, in the form of resource URLs. + */ + zones?: string[] | null; + } + /** + * Contains a list of autoscalers. + */ + export interface Schema$RegionAutoscalerList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Autoscaler resources. + */ + items?: Schema$Autoscaler[]; /** * Type of resource. */ @@ -8062,7 +8303,7 @@ export namespace compute_beta { */ nextHopGateway?: string | null; /** - * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule Note that this can only be used when the destination_range is a public (non-RFC 1918) IP CIDR range. + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule */ nextHopIlb?: string | null; /** @@ -9758,7 +9999,7 @@ export namespace compute_beta { */ name?: string | null; /** - * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. + * Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. - */ quicOverride?: string | null; /** @@ -9774,7 +10015,7 @@ export namespace compute_beta { */ sslCertificates?: string[] | null; /** - * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. + * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. */ sslPolicy?: string | null; /** @@ -11119,7 +11360,7 @@ export namespace compute_beta { */ sharedSecretHash?: string | null; /** - * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. + * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being blacklisted. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. */ status?: string | null; /** @@ -11403,7 +11644,7 @@ export namespace compute_beta { /** * compute.acceleratorTypes.aggregatedList - * @desc Retrieves an aggregated list of accelerator types. + * @desc Retrieves an aggregated list of accelerator types. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11553,7 +11794,7 @@ export namespace compute_beta { /** * compute.acceleratorTypes.get - * @desc Returns the specified accelerator type. + * @desc Returns the specified accelerator type. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11685,7 +11926,7 @@ export namespace compute_beta { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified project. + * @desc Retrieves a list of accelerator types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11918,7 +12159,7 @@ export namespace compute_beta { /** * compute.addresses.aggregatedList - * @desc Retrieves an aggregated list of addresses. + * @desc Retrieves an aggregated list of addresses. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12062,7 +12303,7 @@ export namespace compute_beta { /** * compute.addresses.delete - * @desc Deletes the specified address resource. + * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12194,7 +12435,7 @@ export namespace compute_beta { /** * compute.addresses.get - * @desc Returns the specified address resource. + * @desc Returns the specified address resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12323,7 +12564,7 @@ export namespace compute_beta { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12456,7 +12697,7 @@ export namespace compute_beta { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified region. + * @desc Retrieves a list of addresses contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12600,7 +12841,7 @@ export namespace compute_beta { /** * compute.addresses.setLabels - * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12738,7 +12979,7 @@ export namespace compute_beta { /** * compute.addresses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13066,7 +13307,7 @@ export namespace compute_beta { /** * compute.autoscalers.aggregatedList - * @desc Retrieves an aggregated list of autoscalers. + * @desc Retrieves an aggregated list of autoscalers. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13211,7 +13452,7 @@ export namespace compute_beta { /** * compute.autoscalers.delete - * @desc Deletes the specified autoscaler. + * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13344,7 +13585,7 @@ export namespace compute_beta { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13475,7 +13716,7 @@ export namespace compute_beta { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13609,7 +13850,7 @@ export namespace compute_beta { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified zone. + * @desc Retrieves a list of autoscalers contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13753,7 +13994,7 @@ export namespace compute_beta { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13889,7 +14130,7 @@ export namespace compute_beta { /** * compute.autoscalers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14030,7 +14271,7 @@ export namespace compute_beta { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14384,7 +14625,7 @@ export namespace compute_beta { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend bucket. + * @desc Adds a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -14461,7 +14702,7 @@ export namespace compute_beta { /** * compute.backendBuckets.delete - * @desc Deletes the specified BackendBucket resource. + * @desc Deletes the specified BackendBucket resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14590,7 +14831,7 @@ export namespace compute_beta { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend bucket. + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -14667,7 +14908,7 @@ export namespace compute_beta { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14795,7 +15036,7 @@ export namespace compute_beta { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the data included in the request. + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14924,7 +15165,7 @@ export namespace compute_beta { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the specified project. + * @desc Retrieves the list of BackendBucket resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15064,7 +15305,7 @@ export namespace compute_beta { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15199,7 +15440,7 @@ export namespace compute_beta { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included in the request. + * @desc Updates the specified BackendBucket resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15526,7 +15767,7 @@ export namespace compute_beta { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend service. + * @desc Adds a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -15603,7 +15844,7 @@ export namespace compute_beta { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15753,7 +15994,7 @@ export namespace compute_beta { /** * compute.backendServices.delete - * @desc Deletes the specified BackendService resource. + * @desc Deletes the specified BackendService resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15882,7 +16123,7 @@ export namespace compute_beta { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend service. + * @desc Deletes a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -15959,7 +16200,7 @@ export namespace compute_beta { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of available backend services. + * @desc Returns the specified BackendService resource. Gets a list of available backend services. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16087,7 +16328,7 @@ export namespace compute_beta { /** * compute.backendServices.getHealth - * @desc Gets the most recent health check results for this BackendService. + * @desc Gets the most recent health check results for this BackendService. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16226,7 +16467,7 @@ export namespace compute_beta { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16356,7 +16597,7 @@ export namespace compute_beta { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the specified project. + * @desc Retrieves the list of BackendService resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16497,7 +16738,7 @@ export namespace compute_beta { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16632,7 +16873,7 @@ export namespace compute_beta { /** * compute.backendServices.setSecurityPolicy - * @desc Sets the security policy for the specified backend service. + * @desc Sets the security policy for the specified backend service. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16767,7 +17008,7 @@ export namespace compute_beta { /** * compute.backendServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16904,7 +17145,7 @@ export namespace compute_beta { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -17326,7 +17567,7 @@ export namespace compute_beta { /** * compute.disks.addResourcePolicies - * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.addResourcePolicies * @memberOf! () * @@ -17404,7 +17645,7 @@ export namespace compute_beta { /** * compute.disks.aggregatedList - * @desc Retrieves an aggregated list of persistent disks. + * @desc Retrieves an aggregated list of persistent disks. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -17546,7 +17787,7 @@ export namespace compute_beta { /** * compute.disks.createSnapshot - * @desc Creates a snapshot of a specified persistent disk. + * @desc Creates a snapshot of a specified persistent disk. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -17685,7 +17926,7 @@ export namespace compute_beta { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -17817,7 +18058,7 @@ export namespace compute_beta { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -17946,7 +18187,7 @@ export namespace compute_beta { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -18021,7 +18262,7 @@ export namespace compute_beta { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18154,7 +18395,7 @@ export namespace compute_beta { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified zone. + * @desc Retrieves a list of persistent disks contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18295,7 +18536,7 @@ export namespace compute_beta { /** * compute.disks.removeResourcePolicies - * @desc Removes resource policies from a disk. + * @desc Removes resource policies from a disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.removeResourcePolicies * @memberOf! () * @@ -18375,7 +18616,7 @@ export namespace compute_beta { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the size of the disk. + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18512,7 +18753,7 @@ export namespace compute_beta { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -18587,7 +18828,7 @@ export namespace compute_beta { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18724,7 +18965,7 @@ export namespace compute_beta { /** * compute.disks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19223,7 +19464,7 @@ export namespace compute_beta { /** * compute.diskTypes.aggregatedList - * @desc Retrieves an aggregated list of disk types. + * @desc Retrieves an aggregated list of disk types. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19367,7 +19608,7 @@ export namespace compute_beta { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19496,7 +19737,7 @@ export namespace compute_beta { /** * compute.diskTypes.list - * @desc Retrieves a list of disk types available to the specified project. + * @desc Retrieves a list of disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19726,7 +19967,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.delete - * @desc Deletes the specified externalVpnGateway. + * @desc Deletes the specified externalVpnGateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.delete * @memberOf! () * @@ -19802,7 +20043,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.get - * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.get * @memberOf! () * @@ -19877,7 +20118,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.insert - * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.insert * @memberOf! () * @@ -19953,7 +20194,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.list - * @desc Retrieves the list of ExternalVpnGateway available to the specified project. + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.list * @memberOf! () * @@ -20033,7 +20274,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.setLabels - * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.setLabels * @memberOf! () * @@ -20109,7 +20350,7 @@ export namespace compute_beta { /** * compute.externalVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.testIamPermissions * @memberOf! () * @@ -20324,7 +20565,7 @@ export namespace compute_beta { /** * compute.firewalls.delete - * @desc Deletes the specified firewall. + * @desc Deletes the specified firewall. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20452,7 +20693,7 @@ export namespace compute_beta { /** * compute.firewalls.get - * @desc Returns the specified firewall. + * @desc Returns the specified firewall. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20577,7 +20818,7 @@ export namespace compute_beta { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data included in the request. + * @desc Creates a firewall rule in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20705,7 +20946,7 @@ export namespace compute_beta { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified project. + * @desc Retrieves the list of firewall rules available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20844,7 +21085,7 @@ export namespace compute_beta { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20978,7 +21219,7 @@ export namespace compute_beta { /** * compute.firewalls.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21115,7 +21356,7 @@ export namespace compute_beta { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags. + * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21407,7 +21648,7 @@ export namespace compute_beta { /** * compute.forwardingRules.aggregatedList - * @desc Retrieves an aggregated list of forwarding rules. + * @desc Retrieves an aggregated list of forwarding rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21557,7 +21798,7 @@ export namespace compute_beta { /** * compute.forwardingRules.delete - * @desc Deletes the specified ForwardingRule resource. + * @desc Deletes the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21690,7 +21931,7 @@ export namespace compute_beta { /** * compute.forwardingRules.get - * @desc Returns the specified ForwardingRule resource. + * @desc Returns the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21822,7 +22063,7 @@ export namespace compute_beta { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21956,7 +22197,7 @@ export namespace compute_beta { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22101,7 +22342,7 @@ export namespace compute_beta { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.forwardingRules.patch * @memberOf! () * @@ -22179,7 +22420,7 @@ export namespace compute_beta { /** * compute.forwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22317,7 +22558,7 @@ export namespace compute_beta { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22455,7 +22696,7 @@ export namespace compute_beta { /** * compute.forwardingRules.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22845,7 +23086,7 @@ export namespace compute_beta { /** * compute.globalAddresses.delete - * @desc Deletes the specified address resource. + * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22974,7 +23215,7 @@ export namespace compute_beta { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23100,7 +23341,7 @@ export namespace compute_beta { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23229,7 +23470,7 @@ export namespace compute_beta { /** * compute.globalAddresses.list - * @desc Retrieves a list of global addresses. + * @desc Retrieves a list of global addresses. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23369,7 +23610,7 @@ export namespace compute_beta { /** * compute.globalAddresses.setLabels - * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23502,7 +23743,7 @@ export namespace compute_beta { /** * compute.globalAddresses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23774,7 +24015,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.delete - * @desc Deletes the specified GlobalForwardingRule resource. + * @desc Deletes the specified GlobalForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23903,7 +24144,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24031,7 +24272,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24161,7 +24402,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24302,7 +24543,7 @@ export namespace compute_beta { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.globalForwardingRules.patch * @memberOf! () * @@ -24379,7 +24620,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.setLabels - * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24512,7 +24753,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24646,7 +24887,7 @@ export namespace compute_beta { /** * compute.globalForwardingRules.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24968,7 +25209,7 @@ export namespace compute_beta { /** * compute.globalOperations.aggregatedList - * @desc Retrieves an aggregated list of all operations. + * @desc Retrieves an aggregated list of all operations. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25112,7 +25353,7 @@ export namespace compute_beta { /** * compute.globalOperations.delete - * @desc Deletes the specified Operations resource. + * @desc Deletes the specified Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25235,7 +25476,7 @@ export namespace compute_beta { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25363,7 +25604,7 @@ export namespace compute_beta { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the specified project. + * @desc Retrieves a list of Operation resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25599,7 +25840,7 @@ export namespace compute_beta { /** * compute.healthChecks.aggregatedList - * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. + * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.aggregatedList * @memberOf! () * @@ -25684,7 +25925,7 @@ export namespace compute_beta { /** * compute.healthChecks.delete - * @desc Deletes the specified HealthCheck resource. + * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25813,7 +26054,7 @@ export namespace compute_beta { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25940,7 +26181,7 @@ export namespace compute_beta { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26069,7 +26310,7 @@ export namespace compute_beta { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26209,7 +26450,7 @@ export namespace compute_beta { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26344,7 +26585,7 @@ export namespace compute_beta { /** * compute.healthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26481,7 +26722,7 @@ export namespace compute_beta { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26807,7 +27048,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.delete - * @desc Deletes the specified HttpHealthCheck resource. + * @desc Deletes the specified HttpHealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26936,7 +27177,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27064,7 +27305,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27194,7 +27435,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27335,7 +27576,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27470,7 +27711,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27607,7 +27848,7 @@ export namespace compute_beta { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27906,7 +28147,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.delete - * @desc Deletes the specified HttpsHealthCheck resource. + * @desc Deletes the specified HttpsHealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28035,7 +28276,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28163,7 +28404,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28293,7 +28534,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28436,7 +28677,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28571,7 +28812,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28708,7 +28949,7 @@ export namespace compute_beta { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29007,7 +29248,7 @@ export namespace compute_beta { /** * compute.images.delete - * @desc Deletes the specified image. + * @desc Deletes the specified image. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29134,7 +29375,7 @@ export namespace compute_beta { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29267,7 +29508,7 @@ export namespace compute_beta { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by making a list() request. + * @desc Returns the specified image. Gets a list of available images by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29391,7 +29632,7 @@ export namespace compute_beta { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not deprecated. + * @desc Returns the latest image that is part of an image family and is not deprecated. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29517,7 +29758,7 @@ export namespace compute_beta { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.getIamPolicy * @memberOf! () * @@ -29591,7 +29832,7 @@ export namespace compute_beta { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included in the request. + * @desc Creates an image in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29720,7 +29961,7 @@ export namespace compute_beta { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29859,7 +30100,7 @@ export namespace compute_beta { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.setIamPolicy * @memberOf! () * @@ -29933,7 +30174,7 @@ export namespace compute_beta { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30065,7 +30306,7 @@ export namespace compute_beta { /** * compute.images.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30417,7 +30658,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30555,7 +30796,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by zone. + * @desc Retrieves the list of managed instance groups and groups them by zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30705,7 +30946,7 @@ export namespace compute_beta { /** * 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. + * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -30784,7 +31025,7 @@ export namespace compute_beta { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.createInstances * @memberOf! () * @@ -30862,7 +31103,7 @@ export namespace compute_beta { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30995,7 +31236,7 @@ export namespace compute_beta { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31133,7 +31374,7 @@ export namespace compute_beta { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31267,7 +31508,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31401,7 +31642,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31548,7 +31789,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31721,7 +31962,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31860,7 +32101,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31998,7 +32239,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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. + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32137,7 +32378,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.resizeAdvanced - * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or 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. + * @desc Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or 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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32275,7 +32516,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. + * @desc Modifies the autohealing policies. [Deprecated] This method is deprecated. Please use Patch instead. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32415,7 +32656,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32553,7 +32794,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32691,7 +32932,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32832,7 +33073,7 @@ export namespace compute_beta { /** * compute.instanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listManagedInstances method. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33512,7 +33753,7 @@ export namespace compute_beta { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33650,7 +33891,7 @@ export namespace compute_beta { /** * compute.instanceGroups.aggregatedList - * @desc Retrieves the list of instance groups and sorts them by zone. + * @desc Retrieves the list of instance groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33798,7 +34039,7 @@ export namespace compute_beta { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33931,7 +34172,7 @@ export namespace compute_beta { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -34063,7 +34304,7 @@ export namespace compute_beta { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the parameters that are included in the request. + * @desc Creates an instance group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -34197,7 +34438,7 @@ export namespace compute_beta { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the specified project and zone. + * @desc Retrieves the list of instance groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -34342,7 +34583,7 @@ export namespace compute_beta { /** * compute.instanceGroups.listInstances - * @desc Lists the instances in the specified instance group. + * @desc Lists the instances in the specified instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -34503,7 +34744,7 @@ export namespace compute_beta { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, but does not delete those instances. 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 before the VM instance is removed or deleted. + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. 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 before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -34641,7 +34882,7 @@ export namespace compute_beta { /** * compute.instanceGroups.setNamedPorts - * @desc Sets the named ports for the specified instance group. + * @desc Sets the named ports for the specified instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -34779,7 +35020,7 @@ export namespace compute_beta { /** * compute.instanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35210,7 +35451,7 @@ export namespace compute_beta { /** * compute.instances.addAccessConfig - * @desc Adds an access config to an instance's network interface. + * @desc Adds an access config to an instance's network interface. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35352,7 +35593,7 @@ export namespace compute_beta { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35496,7 +35737,7 @@ export namespace compute_beta { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35635,7 +35876,7 @@ export namespace compute_beta { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35767,7 +36008,7 @@ export namespace compute_beta { /** * compute.instances.deleteAccessConfig - * @desc Deletes an access config from an instance's network interface. + * @desc Deletes an access config from an instance's network interface. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35914,7 +36155,7 @@ export namespace compute_beta { /** * compute.instances.detachDisk - * @desc Detaches a disk from an instance. + * @desc Detaches a disk from an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36051,7 +36292,7 @@ export namespace compute_beta { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36180,7 +36421,7 @@ export namespace compute_beta { /** * compute.instances.getGuestAttributes - * @desc Returns the specified guest attributes entry. + * @desc Returns the specified guest attributes entry. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getGuestAttributes * @memberOf! () * @@ -36260,7 +36501,7 @@ export namespace compute_beta { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -36335,7 +36576,7 @@ export namespace compute_beta { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified instance. + * @desc Returns the last 1 MB of serial port output from the specified instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36471,7 +36712,7 @@ export namespace compute_beta { /** * compute.instances.getShieldedInstanceIdentity - * @desc Returns the Shielded Instance Identity of an instance + * @desc Returns the Shielded Instance Identity of an instance (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getShieldedInstanceIdentity * @memberOf! () * @@ -36551,7 +36792,7 @@ export namespace compute_beta { /** * compute.instances.getShieldedVmIdentity - * @desc Returns the Shielded VM Identity of an instance + * @desc Returns the Shielded VM Identity of an instance (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getShieldedVmIdentity * @memberOf! () * @@ -36629,7 +36870,7 @@ export namespace compute_beta { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the data included in the request. + * @desc Creates an instance resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36763,7 +37004,7 @@ export namespace compute_beta { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified zone. + * @desc Retrieves the list of instances contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36907,7 +37148,7 @@ export namespace compute_beta { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37061,7 +37302,7 @@ export namespace compute_beta { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37193,7 +37434,7 @@ export namespace compute_beta { /** * compute.instances.resume - * @desc Resumes an instance that was suspended using the instances().suspend method. + * @desc Resumes an instance that was suspended using the instances().suspend method. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.resume * @memberOf! () * @@ -37270,7 +37511,7 @@ export namespace compute_beta { /** * compute.instances.setDeletionProtection - * @desc Sets deletion protection on the instance. + * @desc Sets deletion protection on the instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37406,7 +37647,7 @@ export namespace compute_beta { /** * compute.instances.setDiskAutoDelete - * @desc Sets the auto-delete flag for a disk attached to an instance. + * @desc Sets the auto-delete flag for a disk attached to an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37553,7 +37794,7 @@ export namespace compute_beta { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -37628,7 +37869,7 @@ export namespace compute_beta { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37766,7 +38007,7 @@ export namespace compute_beta { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37904,7 +38145,7 @@ export namespace compute_beta { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type specified in the request. + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38042,7 +38283,7 @@ export namespace compute_beta { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in the request. + * @desc Sets metadata for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38180,7 +38421,7 @@ export namespace compute_beta { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38318,7 +38559,7 @@ export namespace compute_beta { /** * compute.instances.setScheduling - * @desc Sets an instance's scheduling options. + * @desc Sets an instance's scheduling options. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38456,7 +38697,7 @@ export namespace compute_beta { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38594,7 +38835,7 @@ export namespace compute_beta { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -38674,7 +38915,7 @@ export namespace compute_beta { /** * compute.instances.setShieldedVmIntegrityPolicy - * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setShieldedVmIntegrityPolicy * @memberOf! () * @@ -38754,7 +38995,7 @@ export namespace compute_beta { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included in the request. + * @desc Sets network tags for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38892,7 +39133,7 @@ export namespace compute_beta { /** * compute.instances.simulateMaintenanceEvent - * @desc Simulates a maintenance event on the instance. + * @desc Simulates a maintenance event on the instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.simulateMaintenanceEvent * @memberOf! () * @@ -38970,7 +39211,7 @@ export namespace compute_beta { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39102,7 +39343,7 @@ export namespace compute_beta { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39242,7 +39483,7 @@ export namespace compute_beta { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39374,7 +39615,7 @@ export namespace compute_beta { /** * compute.instances.suspend - * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. + * @desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.suspend * @memberOf! () * @@ -39452,7 +39693,7 @@ export namespace compute_beta { /** * compute.instances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39593,7 +39834,7 @@ export namespace compute_beta { /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39735,7 +39976,7 @@ export namespace compute_beta { /** * compute.instances.updateDisplayDevice - * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateDisplayDevice * @memberOf! () * @@ -39813,7 +40054,7 @@ export namespace compute_beta { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH semantics. + * @desc Updates an instance's network interface. This method follows PATCH semantics. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39958,7 +40199,7 @@ export namespace compute_beta { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -40038,7 +40279,7 @@ export namespace compute_beta { /** * compute.instances.updateShieldedVmConfig - * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateShieldedVmConfig * @memberOf! () * @@ -41264,7 +41505,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41393,7 +41634,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41521,7 +41762,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -41595,7 +41836,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41725,7 +41966,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within the specified project. + * @desc Retrieves a list of instance templates that are contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41868,7 +42109,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -41942,7 +42183,7 @@ export namespace compute_beta { /** * compute.instanceTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -42234,7 +42475,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.aggregatedList - * @desc Retrieves an aggregated list of interconnect attachments. + * @desc Retrieves an aggregated list of interconnect attachments. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -42392,7 +42633,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.delete - * @desc Deletes the specified interconnect attachment. + * @desc Deletes the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -42525,7 +42766,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.get - * @desc Returns the specified interconnect attachment. + * @desc Returns the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -42659,7 +42900,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -42793,7 +43034,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the specified region. + * @desc Retrieves the list of interconnect attachments contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -42945,7 +43186,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -43023,7 +43264,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.setLabels - * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.setLabels * @memberOf! () * @@ -43101,7 +43342,7 @@ export namespace compute_beta { /** * compute.interconnectAttachments.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -43462,7 +43703,7 @@ export namespace compute_beta { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -43592,7 +43833,7 @@ export namespace compute_beta { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the specified project. + * @desc Retrieves the list of interconnect locations available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -43787,7 +44028,7 @@ export namespace compute_beta { /** * compute.interconnects.delete - * @desc Deletes the specified interconnect. + * @desc Deletes the specified interconnect. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -43916,7 +44157,7 @@ export namespace compute_beta { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -44044,7 +44285,7 @@ export namespace compute_beta { /** * compute.interconnects.getDiagnostics - * @desc Returns the interconnectDiagnostics for the specified interconnect. + * @desc Returns the interconnectDiagnostics for the specified interconnect. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.getDiagnostics * @memberOf! () * @@ -44130,7 +44371,7 @@ export namespace compute_beta { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data included in the request. + * @desc Creates a Interconnect in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -44259,7 +44500,7 @@ export namespace compute_beta { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified project. + * @desc Retrieves the list of interconnect available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -44399,7 +44640,7 @@ export namespace compute_beta { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -44534,7 +44775,7 @@ export namespace compute_beta { /** * compute.interconnects.setLabels - * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.setLabels * @memberOf! () * @@ -44610,7 +44851,7 @@ export namespace compute_beta { /** * compute.interconnects.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -44923,7 +45164,7 @@ export namespace compute_beta { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenseCodes.get * @memberOf! () * @@ -45020,7 +45261,7 @@ export namespace compute_beta { /** * compute.licenses.delete - * @desc Deletes the specified license. + * @desc Deletes the specified license. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.delete * @memberOf! () * @@ -45095,7 +45336,7 @@ export namespace compute_beta { /** * compute.licenses.get - * @desc Returns the specified License resource. + * @desc Returns the specified License resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45220,7 +45461,7 @@ export namespace compute_beta { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -45294,7 +45535,7 @@ export namespace compute_beta { /** * compute.licenses.insert - * @desc Create a License resource in the specified project. + * @desc Create a License resource in the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.insert * @memberOf! () * @@ -45368,7 +45609,7 @@ export namespace compute_beta { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.list * @memberOf! () * @@ -45446,7 +45687,7 @@ export namespace compute_beta { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -45650,7 +45891,7 @@ export namespace compute_beta { /** * compute.machineTypes.aggregatedList - * @desc Retrieves an aggregated list of machine types. + * @desc Retrieves an aggregated list of machine types. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45798,7 +46039,7 @@ export namespace compute_beta { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45929,7 +46170,7 @@ export namespace compute_beta { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified project. + * @desc Retrieves a list of machine types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -46161,7 +46402,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by zone. + * @desc Retrieves the list of network endpoint groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * @@ -46248,7 +46489,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network endpoint group. + * @desc Attach a list of network endpoints to the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -46328,7 +46569,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. + * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.delete * @memberOf! () * @@ -46405,7 +46646,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network endpoint group. + * @desc Detach a list of network endpoints from the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -46485,7 +46726,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -46563,7 +46804,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -46640,7 +46881,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -46721,7 +46962,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint group. + * @desc Lists the network endpoints in the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -46825,7 +47066,7 @@ export namespace compute_beta { /** * compute.networkEndpointGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.testIamPermissions * @memberOf! () * @@ -47167,7 +47408,7 @@ export namespace compute_beta { /** * compute.networks.addPeering - * @desc Adds a peering to the specified network. + * @desc Adds a peering to the specified network. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47301,7 +47542,7 @@ export namespace compute_beta { /** * compute.networks.delete - * @desc Deletes the specified network. + * @desc Deletes the specified network. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47429,7 +47670,7 @@ export namespace compute_beta { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by making a list() request. + * @desc Returns the specified network. Gets a list of available networks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47554,7 +47795,7 @@ export namespace compute_beta { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included in the request. + * @desc Creates a network in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47682,7 +47923,7 @@ export namespace compute_beta { /** * compute.networks.list - * @desc Retrieves the list of networks available to the specified project. + * @desc Retrieves the list of networks available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47821,7 +48062,7 @@ export namespace compute_beta { /** * compute.networks.listPeeringRoutes - * @desc Lists the peering routes exchanged over peering connection. + * @desc Lists the peering routes exchanged over peering connection. (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.listPeeringRoutes * @memberOf! () * @@ -47910,7 +48151,7 @@ export namespace compute_beta { /** * compute.networks.patch - * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. + * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48044,7 +48285,7 @@ export namespace compute_beta { /** * compute.networks.removePeering - * @desc Removes a peering from the specified network. + * @desc Removes a peering from the specified network. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48178,7 +48419,7 @@ export namespace compute_beta { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet mode. + * @desc Switches the network mode from auto subnet mode to custom subnet mode. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48307,7 +48548,7 @@ export namespace compute_beta { /** * compute.networks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48444,7 +48685,7 @@ export namespace compute_beta { /** * compute.networks.updatePeering - * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes + * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.updatePeering * @memberOf! () * @@ -48794,7 +49035,7 @@ export namespace compute_beta { /** * compute.nodeGroups.addNodes - * @desc Adds specified number of nodes to the node group. + * @desc Adds specified number of nodes to the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.addNodes * @memberOf! () * @@ -48872,7 +49113,7 @@ export namespace compute_beta { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -48953,7 +49194,7 @@ export namespace compute_beta { /** * compute.nodeGroups.delete - * @desc Deletes the specified NodeGroup resource. + * @desc Deletes the specified NodeGroup resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.delete * @memberOf! () * @@ -49030,7 +49271,7 @@ export namespace compute_beta { /** * compute.nodeGroups.deleteNodes - * @desc Deletes specified nodes from the node group. + * @desc Deletes specified nodes from the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.deleteNodes * @memberOf! () * @@ -49108,7 +49349,7 @@ export namespace compute_beta { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.get * @memberOf! () * @@ -49183,7 +49424,7 @@ export namespace compute_beta { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -49258,7 +49499,7 @@ export namespace compute_beta { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the data included in the request. + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.insert * @memberOf! () * @@ -49336,7 +49577,7 @@ export namespace compute_beta { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.list * @memberOf! () * @@ -49414,7 +49655,7 @@ export namespace compute_beta { /** * compute.nodeGroups.listNodes - * @desc Lists nodes in the node group. + * @desc Lists nodes in the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.listNodes * @memberOf! () * @@ -49494,7 +49735,7 @@ export namespace compute_beta { /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -49569,7 +49810,7 @@ export namespace compute_beta { /** * compute.nodeGroups.setNodeTemplate - * @desc Updates the node template of the node group. + * @desc Updates the node template of the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.setNodeTemplate * @memberOf! () * @@ -49647,7 +49888,7 @@ export namespace compute_beta { /** * compute.nodeGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.testIamPermissions * @memberOf! () * @@ -50064,7 +50305,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.aggregatedList - * @desc Retrieves an aggregated list of node templates. + * @desc Retrieves an aggregated list of node templates. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.aggregatedList * @memberOf! () * @@ -50149,7 +50390,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.delete - * @desc Deletes the specified NodeTemplate resource. + * @desc Deletes the specified NodeTemplate resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.delete * @memberOf! () * @@ -50226,7 +50467,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.get * @memberOf! () * @@ -50302,7 +50543,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -50377,7 +50618,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -50454,7 +50695,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified project. + * @desc Retrieves a list of node templates available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.list * @memberOf! () * @@ -50533,7 +50774,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -50608,7 +50849,7 @@ export namespace compute_beta { /** * compute.nodeTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.testIamPermissions * @memberOf! () * @@ -50900,7 +51141,7 @@ export namespace compute_beta { /** * compute.nodeTypes.aggregatedList - * @desc Retrieves an aggregated list of node types. + * @desc Retrieves an aggregated list of node types. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.aggregatedList * @memberOf! () * @@ -50981,7 +51222,7 @@ export namespace compute_beta { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node types by making a list() request. + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.get * @memberOf! () * @@ -51054,7 +51295,7 @@ export namespace compute_beta { /** * compute.nodeTypes.list - * @desc Retrieves a list of node types available to the specified project. + * @desc Retrieves a list of node types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.list * @memberOf! () * @@ -51210,6 +51451,752 @@ export namespace compute_beta { zone?: string; } + export class Resource$Packetmirrorings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.packetMirrorings.aggregatedList + * @desc Retrieves an aggregated list of packetMirrorings. (== suppress_warning http-rest-shadowed ==) + * @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/beta/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. (== suppress_warning http-rest-shadowed ==) + * @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/beta/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. (== suppress_warning http-rest-shadowed ==) + * @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/beta/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. (== suppress_warning http-rest-shadowed ==) + * @alias compute.packetMirrorings.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().PacketMirroring} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Packetmirrorings$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Packetmirrorings$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Packetmirrorings$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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. (== suppress_warning http-rest-shadowed ==) + * @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/beta/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. (== suppress_warning http-rest-shadowed ==) + * @alias compute.packetMirrorings.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().PacketMirroring} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Packetmirrorings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Packetmirrorings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Packetmirrorings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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. (== suppress_warning http-rest-shadowed ==) + * @alias compute.packetMirrorings.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Packetmirrorings$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Packetmirrorings$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Packetmirrorings$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to delete. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Packetmirrorings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to return. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Packetmirrorings$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Packetmirrorings$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the PacketMirroring resource to patch. + */ + packetMirroring?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export class Resource$Projects { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -51218,7 +52205,7 @@ export namespace compute_beta { /** * compute.projects.disableXpnHost - * @desc Disable this project as a shared VPC host project. + * @desc Disable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51342,7 +52329,7 @@ export namespace compute_beta { /** * compute.projects.disableXpnResource - * @desc Disable a service resource (also known as service project) associated with this host project. + * @desc Disable a service resource (also known as service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51471,7 +52458,7 @@ export namespace compute_beta { /** * compute.projects.enableXpnHost - * @desc Enable this project as a shared VPC host project. + * @desc Enable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51595,7 +52582,7 @@ export namespace compute_beta { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51724,7 +52711,7 @@ export namespace compute_beta { /** * compute.projects.get - * @desc Returns the specified Project resource. + * @desc Returns the specified Project resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51845,7 +52832,7 @@ export namespace compute_beta { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51966,7 +52953,7 @@ export namespace compute_beta { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this host project. + * @desc Gets service resources (a.k.a service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52110,7 +53097,7 @@ export namespace compute_beta { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an organization. + * @desc Lists all shared VPC host projects visible to the user in an organization. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52255,7 +53242,7 @@ export namespace compute_beta { /** * compute.projects.moveDisk - * @desc Moves a persistent disk from one zone to another. + * @desc Moves a persistent disk from one zone to another. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52384,7 +53371,7 @@ export namespace compute_beta { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone to another. + * @desc Moves an instance and its attached persistent disks from one zone to another. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52513,7 +53500,7 @@ export namespace compute_beta { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project using the data included in the request. + * @desc Sets metadata common to all instances within the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52645,7 +53632,7 @@ export namespace compute_beta { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -52722,7 +53709,7 @@ export namespace compute_beta { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53124,7 +54111,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.delete - * @desc Deletes the specified autoscaler. + * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53257,7 +54244,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.get - * @desc Returns the specified autoscaler. + * @desc Returns the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53389,7 +54376,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53523,7 +54510,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified region. + * @desc Retrieves a list of autoscalers contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53670,7 +54657,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53806,7 +54793,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53947,7 +54934,7 @@ export namespace compute_beta { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54275,7 +55262,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.delete - * @desc Deletes the specified regional BackendService resource. + * @desc Deletes the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54408,7 +55395,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.get - * @desc Returns the specified regional BackendService resource. + * @desc Returns the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54540,7 +55527,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional BackendService. + * @desc Gets the most recent health check results for this regional BackendService. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54683,7 +55670,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54817,7 +55804,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54962,7 +55949,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -55101,7 +56088,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -55242,7 +56229,7 @@ export namespace compute_beta { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -55598,7 +56585,7 @@ export namespace compute_beta { /** * compute.regionCommitments.aggregatedList - * @desc Retrieves an aggregated list of commitments. + * @desc Retrieves an aggregated list of commitments. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -55743,7 +56730,7 @@ export namespace compute_beta { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -55875,7 +56862,7 @@ export namespace compute_beta { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data included in the request. + * @desc Creates a commitment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -56009,7 +56996,7 @@ export namespace compute_beta { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified region. + * @desc Retrieves a list of commitments contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -56154,7 +57141,7 @@ export namespace compute_beta { /** * compute.regionCommitments.updateReservations - * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. + * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionCommitments.updateReservations * @memberOf! () * @@ -56374,7 +57361,7 @@ export namespace compute_beta { /** * compute.regionDisks.addResourcePolicies - * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.addResourcePolicies * @memberOf! () * @@ -56452,7 +57439,7 @@ export namespace compute_beta { /** * compute.regionDisks.createSnapshot - * @desc Creates a snapshot of this regional disk. + * @desc Creates a snapshot of this regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.createSnapshot * @memberOf! () * @@ -56530,7 +57517,7 @@ export namespace compute_beta { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.delete * @memberOf! () * @@ -56607,7 +57594,7 @@ export namespace compute_beta { /** * compute.regionDisks.get - * @desc Returns a specified regional persistent disk. + * @desc Returns a specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.get * @memberOf! () * @@ -56680,7 +57667,7 @@ export namespace compute_beta { /** * compute.regionDisks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.getIamPolicy * @memberOf! () * @@ -56755,7 +57742,7 @@ export namespace compute_beta { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using the data included in the request. + * @desc Creates a persistent regional disk in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.insert * @memberOf! () * @@ -56833,7 +57820,7 @@ export namespace compute_beta { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the specified region. + * @desc Retrieves the list of persistent disks contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.list * @memberOf! () * @@ -56909,7 +57896,7 @@ export namespace compute_beta { /** * compute.regionDisks.removeResourcePolicies - * @desc Removes resource policies from a regional disk. + * @desc Removes resource policies from a regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.removeResourcePolicies * @memberOf! () * @@ -56989,7 +57976,7 @@ export namespace compute_beta { /** * compute.regionDisks.resize - * @desc Resizes the specified regional persistent disk. + * @desc Resizes the specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.resize * @memberOf! () * @@ -57067,7 +58054,7 @@ export namespace compute_beta { /** * compute.regionDisks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.setIamPolicy * @memberOf! () * @@ -57142,7 +58129,7 @@ export namespace compute_beta { /** * compute.regionDisks.setLabels - * @desc Sets the labels on the target regional disk. + * @desc Sets the labels on the target regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.setLabels * @memberOf! () * @@ -57220,7 +58207,7 @@ export namespace compute_beta { /** * compute.regionDisks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.testIamPermissions * @memberOf! () * @@ -57631,7 +58618,7 @@ export namespace compute_beta { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -57705,7 +58692,7 @@ export namespace compute_beta { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified project. + * @desc Retrieves a list of regional disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -57844,7 +58831,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.delete - * @desc Deletes the specified HealthCheck resource. + * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.delete * @memberOf! () * @@ -57921,7 +58908,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.get * @memberOf! () * @@ -57997,7 +58984,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.insert * @memberOf! () * @@ -58074,7 +59061,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.list * @memberOf! () * @@ -58153,7 +59140,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.patch * @memberOf! () * @@ -58231,7 +59218,7 @@ export namespace compute_beta { /** * compute.regionHealthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.update * @memberOf! () * @@ -58476,7 +59463,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -58614,7 +59601,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.applyUpdatesToInstances - * @desc Apply updates to selected instances the managed instance group. + * @desc Apply updates to selected instances the managed instance group. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.applyUpdatesToInstances * @memberOf! () * @@ -58693,7 +59680,7 @@ export namespace compute_beta { /** * 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.createInstances * @memberOf! () * @@ -58771,7 +59758,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. + * @desc Deletes the specified managed instance group and all of the instances in that group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -58904,7 +59891,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59042,7 +60029,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. + * @desc Returns all of the details about the specified managed instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59176,7 +60163,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59310,7 +60297,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained within the specified region. + * @desc Retrieves the list of managed instance groups that are contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59464,7 +60451,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59637,7 +60624,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59776,7 +60763,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59914,7 +60901,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60051,7 +61038,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setAutoHealingPolicies - * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. + * @desc Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Please use Patch instead. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60191,7 +61178,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60329,7 +61316,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60467,7 +61454,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60608,7 +61595,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroupManagers.update - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -61231,7 +62218,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.get - * @desc Returns the specified instance group resource. + * @desc Returns the specified instance group resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -61363,7 +62350,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the specified region. + * @desc Retrieves the list of instance group resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -61510,7 +62497,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -61673,7 +62660,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.setNamedPorts - * @desc Sets the named ports for the specified regional instance group. + * @desc Sets the named ports for the specified regional instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -61811,7 +62798,7 @@ export namespace compute_beta { /** * compute.regionInstanceGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62107,7 +63094,7 @@ export namespace compute_beta { /** * compute.regionOperations.delete - * @desc Deletes the specified region-specific Operations resource. + * @desc Deletes the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62234,7 +63221,7 @@ export namespace compute_beta { /** * compute.regionOperations.get - * @desc Retrieves the specified region-specific Operations resource. + * @desc Retrieves the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62366,7 +63353,7 @@ export namespace compute_beta { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the specified region. + * @desc Retrieves a list of Operation resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62591,7 +63578,7 @@ export namespace compute_beta { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62715,7 +63702,7 @@ export namespace compute_beta { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified project. + * @desc Retrieves the list of region resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62905,7 +63892,7 @@ export namespace compute_beta { /** * compute.regionSslCertificates.delete - * @desc Deletes the specified SslCertificate resource in the region. + * @desc Deletes the specified SslCertificate resource in the region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.delete * @memberOf! () * @@ -62982,7 +63969,7 @@ export namespace compute_beta { /** * compute.regionSslCertificates.get - * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.get * @memberOf! () * @@ -63058,7 +64045,7 @@ export namespace compute_beta { /** * compute.regionSslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.insert * @memberOf! () * @@ -63135,7 +64122,7 @@ export namespace compute_beta { /** * compute.regionSslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.list * @memberOf! () * @@ -63323,7 +64310,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. + * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.delete * @memberOf! () * @@ -63400,7 +64387,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.get * @memberOf! () * @@ -63476,7 +64463,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.insert * @memberOf! () * @@ -63553,7 +64540,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.list * @memberOf! () * @@ -63632,7 +64619,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. + * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.setUrlMap * @memberOf! () * @@ -63848,7 +64835,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. + * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.delete * @memberOf! () * @@ -63925,7 +64912,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.get * @memberOf! () * @@ -64001,7 +64988,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.insert * @memberOf! () * @@ -64078,7 +65065,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.list * @memberOf! () * @@ -64159,7 +65146,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. + * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.setSslCertificates * @memberOf! () * @@ -64237,7 +65224,7 @@ export namespace compute_beta { /** * compute.regionTargetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. + * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.setUrlMap * @memberOf! () * @@ -64482,7 +65469,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.delete - * @desc Deletes the specified UrlMap resource. + * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.delete * @memberOf! () * @@ -64559,7 +65546,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.get * @memberOf! () * @@ -64633,7 +65620,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.insert * @memberOf! () * @@ -64710,7 +65697,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.invalidateCache * @memberOf! () * @@ -64788,7 +65775,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.list * @memberOf! () * @@ -64867,7 +65854,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.patch * @memberOf! () * @@ -64945,7 +65932,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. + * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.update * @memberOf! () * @@ -65023,7 +66010,7 @@ export namespace compute_beta { /** * compute.regionUrlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.validate * @memberOf! () * @@ -65325,7 +66312,7 @@ export namespace compute_beta { /** * compute.reservations.aggregatedList - * @desc Retrieves an aggregated list of reservations. + * @desc Retrieves an aggregated list of reservations. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.aggregatedList * @memberOf! () * @@ -65410,7 +66397,7 @@ export namespace compute_beta { /** * compute.reservations.delete - * @desc Deletes the specified reservation. + * @desc Deletes the specified reservation. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.delete * @memberOf! () * @@ -65487,7 +66474,7 @@ export namespace compute_beta { /** * compute.reservations.get - * @desc Retrieves information about the specified reservation. + * @desc Retrieves information about the specified reservation. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.get * @memberOf! () * @@ -65562,7 +66549,7 @@ export namespace compute_beta { /** * compute.reservations.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.getIamPolicy * @memberOf! () * @@ -65637,7 +66624,7 @@ export namespace compute_beta { /** * compute.reservations.insert - * @desc Creates a new reservation. For more information, read Reserving zonal resources. + * @desc Creates a new reservation. For more information, read Reserving zonal resources. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.insert * @memberOf! () * @@ -65714,7 +66701,7 @@ export namespace compute_beta { /** * compute.reservations.list - * @desc A list of all the reservations that have been configured for the specified project in specified zone. + * @desc A list of all the reservations that have been configured for the specified project in specified zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.list * @memberOf! () * @@ -65793,7 +66780,7 @@ export namespace compute_beta { /** * compute.reservations.resize - * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. + * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.resize * @memberOf! () * @@ -65871,7 +66858,7 @@ export namespace compute_beta { /** * compute.reservations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.setIamPolicy * @memberOf! () * @@ -65946,7 +66933,7 @@ export namespace compute_beta { /** * compute.reservations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.testIamPermissions * @memberOf! () * @@ -66266,7 +67253,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.aggregatedList - * @desc Retrieves an aggregated list of resource policies. + * @desc Retrieves an aggregated list of resource policies. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.aggregatedList * @memberOf! () * @@ -66353,7 +67340,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.delete - * @desc Deletes the specified resource policy. + * @desc Deletes the specified resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.delete * @memberOf! () * @@ -66430,7 +67417,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.get - * @desc Retrieves all information of the specified resource policy. + * @desc Retrieves all information of the specified resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.get * @memberOf! () * @@ -66506,7 +67493,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.getIamPolicy * @memberOf! () * @@ -66581,7 +67568,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.insert - * @desc Creates a new resource policy. + * @desc Creates a new resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.insert * @memberOf! () * @@ -66658,7 +67645,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.list - * @desc A list all the resource policies that have been configured for the specified project in specified region. + * @desc A list all the resource policies that have been configured for the specified project in specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.list * @memberOf! () * @@ -66737,7 +67724,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.setIamPolicy * @memberOf! () * @@ -66812,7 +67799,7 @@ export namespace compute_beta { /** * compute.resourcePolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.testIamPermissions * @memberOf! () * @@ -67104,7 +68091,7 @@ export namespace compute_beta { /** * compute.routers.aggregatedList - * @desc Retrieves an aggregated list of routers. + * @desc Retrieves an aggregated list of routers. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67248,7 +68235,7 @@ export namespace compute_beta { /** * compute.routers.delete - * @desc Deletes the specified Router resource. + * @desc Deletes the specified Router resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67380,7 +68367,7 @@ export namespace compute_beta { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67509,7 +68496,7 @@ export namespace compute_beta { /** * compute.routers.getNatMappingInfo - * @desc Retrieves runtime Nat mapping information of VM endpoints. + * @desc Retrieves runtime Nat mapping information of VM endpoints. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.getNatMappingInfo * @memberOf! () * @@ -67597,7 +68584,7 @@ export namespace compute_beta { /** * compute.routers.getRouterStatus - * @desc Retrieves runtime information of the specified router. + * @desc Retrieves runtime information of the specified router. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67733,7 +68720,7 @@ export namespace compute_beta { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using the data included in the request. + * @desc Creates a Router resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67866,7 +68853,7 @@ export namespace compute_beta { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified project. + * @desc Retrieves a list of Router resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68010,7 +68997,7 @@ export namespace compute_beta { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68148,7 +69135,7 @@ export namespace compute_beta { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68288,7 +69275,7 @@ export namespace compute_beta { /** * compute.routers.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68429,7 +69416,7 @@ export namespace compute_beta { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68865,7 +69852,7 @@ export namespace compute_beta { /** * compute.routes.delete - * @desc Deletes the specified Route resource. + * @desc Deletes the specified Route resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68992,7 +69979,7 @@ export namespace compute_beta { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69116,7 +70103,7 @@ export namespace compute_beta { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data included in the request. + * @desc Creates a Route resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69244,7 +70231,7 @@ export namespace compute_beta { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified project. + * @desc Retrieves the list of Route resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69383,7 +70370,7 @@ export namespace compute_beta { /** * compute.routes.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69630,7 +70617,7 @@ export namespace compute_beta { /** * compute.securityPolicies.addRule - * @desc Inserts a rule into a security policy. + * @desc Inserts a rule into a security policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.addRule * @memberOf! () * @@ -69707,7 +70694,7 @@ export namespace compute_beta { /** * compute.securityPolicies.delete - * @desc Deletes the specified policy. + * @desc Deletes the specified policy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69836,7 +70823,7 @@ export namespace compute_beta { /** * compute.securityPolicies.get - * @desc List all of the ordered rules present in a single specified policy. + * @desc List all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69964,7 +70951,7 @@ export namespace compute_beta { /** * compute.securityPolicies.getRule - * @desc Gets a rule at the specified priority. + * @desc Gets a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.getRule * @memberOf! () * @@ -70040,7 +71027,7 @@ export namespace compute_beta { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data included in the request. + * @desc Creates a new policy in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -70171,7 +71158,7 @@ export namespace compute_beta { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified project. + * @desc List all the policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -70312,7 +71299,7 @@ export namespace compute_beta { /** * compute.securityPolicies.listPreconfiguredExpressionSets - * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. + * @desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.listPreconfiguredExpressionSets * @memberOf! () * @@ -70416,7 +71403,7 @@ export namespace compute_beta { /** * compute.securityPolicies.patch - * @desc Patches the specified policy with the data included in the request. + * @desc Patches the specified policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -70551,7 +71538,7 @@ export namespace compute_beta { /** * compute.securityPolicies.patchRule - * @desc Patches a rule at the specified priority. + * @desc Patches a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.patchRule * @memberOf! () * @@ -70629,7 +71616,7 @@ export namespace compute_beta { /** * compute.securityPolicies.removeRule - * @desc Deletes a rule at the specified priority. + * @desc Deletes a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.removeRule * @memberOf! () * @@ -70705,7 +71692,7 @@ export namespace compute_beta { /** * compute.securityPolicies.setLabels - * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.setLabels * @memberOf! () * @@ -70781,7 +71768,7 @@ export namespace compute_beta { /** * compute.securityPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71204,7 +72191,7 @@ export namespace compute_beta { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71332,7 +72319,7 @@ export namespace compute_beta { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71457,7 +72444,7 @@ export namespace compute_beta { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -71531,7 +72518,7 @@ export namespace compute_beta { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the specified project. + * @desc Retrieves the list of Snapshot resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71670,7 +72657,7 @@ export namespace compute_beta { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -71744,7 +72731,7 @@ export namespace compute_beta { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71877,7 +72864,7 @@ export namespace compute_beta { /** * compute.snapshots.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72166,7 +73153,7 @@ export namespace compute_beta { /** * compute.sslCertificates.aggregatedList - * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. + * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslCertificates.aggregatedList * @memberOf! () * @@ -72253,7 +73240,7 @@ export namespace compute_beta { /** * compute.sslCertificates.delete - * @desc Deletes the specified SslCertificate resource. + * @desc Deletes the specified SslCertificate resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72382,7 +73369,7 @@ export namespace compute_beta { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72510,7 +73497,7 @@ export namespace compute_beta { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using the data included in the request. + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72640,7 +73627,7 @@ export namespace compute_beta { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project. + * @desc Retrieves the list of SslCertificate resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72781,7 +73768,7 @@ export namespace compute_beta { /** * compute.sslCertificates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -73060,7 +74047,7 @@ export namespace compute_beta { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.delete * @memberOf! () * @@ -73136,7 +74123,7 @@ export namespace compute_beta { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified policy. + * @desc Lists all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.get * @memberOf! () * @@ -73210,7 +74197,7 @@ export namespace compute_beta { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.insert * @memberOf! () * @@ -73285,7 +74272,7 @@ export namespace compute_beta { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the specified project. + * @desc Lists all the SSL policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.list * @memberOf! () * @@ -73361,7 +74348,7 @@ export namespace compute_beta { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when using custom profile. + * @desc Lists all features that can be specified in the SSL policy when using custom profile. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -73456,7 +74443,7 @@ export namespace compute_beta { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the request. + * @desc Patches the specified SSL policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.patch * @memberOf! () * @@ -73533,7 +74520,7 @@ export namespace compute_beta { /** * compute.sslPolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.testIamPermissions * @memberOf! () * @@ -73778,7 +74765,7 @@ export namespace compute_beta { /** * compute.subnetworks.aggregatedList - * @desc Retrieves an aggregated list of subnetworks. + * @desc Retrieves an aggregated list of subnetworks. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -73923,7 +74910,7 @@ export namespace compute_beta { /** * compute.subnetworks.delete - * @desc Deletes the specified subnetwork. + * @desc Deletes the specified subnetwork. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74056,7 +75043,7 @@ export namespace compute_beta { /** * compute.subnetworks.expandIpCidrRange - * @desc Expands the IP CIDR range of the subnetwork to a specified value. + * @desc Expands the IP CIDR range of the subnetwork to a specified value. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74194,7 +75181,7 @@ export namespace compute_beta { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74325,7 +75312,7 @@ export namespace compute_beta { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74456,7 +75443,7 @@ export namespace compute_beta { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data included in the request. + * @desc Creates a subnetwork in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74590,7 +75577,7 @@ export namespace compute_beta { /** * compute.subnetworks.list - * @desc Retrieves a list of subnetworks available to the specified project. + * @desc Retrieves a list of subnetworks available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74734,7 +75721,7 @@ export namespace compute_beta { /** * compute.subnetworks.listUsable - * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. + * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.listUsable * @memberOf! () * @@ -74821,7 +75808,7 @@ export namespace compute_beta { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74961,7 +75948,7 @@ export namespace compute_beta { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -75096,7 +76083,7 @@ export namespace compute_beta { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -75236,7 +76223,7 @@ export namespace compute_beta { /** * compute.subnetworks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -75705,7 +76692,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. + * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.aggregatedList * @memberOf! () * @@ -75792,7 +76779,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. + * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -75921,7 +76908,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76049,7 +77036,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76179,7 +77166,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76320,7 +77307,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. + * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76454,7 +77441,7 @@ export namespace compute_beta { /** * compute.targetHttpProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76758,7 +77745,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. + * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.aggregatedList * @memberOf! () * @@ -76845,7 +77832,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. + * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76974,7 +77961,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -77102,7 +78089,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -77232,7 +78219,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -77375,7 +78362,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setQuicOverride - * @desc Sets the QUIC override policy for TargetHttpsProxy. + * @desc Sets the QUIC override policy for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.setQuicOverride * @memberOf! () * @@ -77452,7 +78439,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. + * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -77586,7 +78573,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -77663,7 +78650,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. + * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -77797,7 +78784,7 @@ export namespace compute_beta { /** * compute.targetHttpsProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -78176,7 +79163,7 @@ export namespace compute_beta { /** * compute.targetInstances.aggregatedList - * @desc Retrieves an aggregated list of target instances. + * @desc Retrieves an aggregated list of target instances. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -78326,7 +79313,7 @@ export namespace compute_beta { /** * compute.targetInstances.delete - * @desc Deletes the specified TargetInstance resource. + * @desc Deletes the specified TargetInstance resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -78459,7 +79446,7 @@ export namespace compute_beta { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -78591,7 +79578,7 @@ export namespace compute_beta { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -78725,7 +79712,7 @@ export namespace compute_beta { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -78870,7 +79857,7 @@ export namespace compute_beta { /** * compute.targetInstances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -79173,7 +80160,7 @@ export namespace compute_beta { /** * compute.targetPools.addHealthCheck - * @desc Adds health check URLs to a target pool. + * @desc Adds health check URLs to a target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -79311,7 +80298,7 @@ export namespace compute_beta { /** * compute.targetPools.addInstance - * @desc Adds an instance to a target pool. + * @desc Adds an instance to a target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -79449,7 +80436,7 @@ export namespace compute_beta { /** * compute.targetPools.aggregatedList - * @desc Retrieves an aggregated list of target pools. + * @desc Retrieves an aggregated list of target pools. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -79594,7 +80581,7 @@ export namespace compute_beta { /** * compute.targetPools.delete - * @desc Deletes the specified target pool. + * @desc Deletes the specified target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -79727,7 +80714,7 @@ export namespace compute_beta { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -79858,7 +80845,7 @@ export namespace compute_beta { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -79999,7 +80986,7 @@ export namespace compute_beta { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the data included in the request. + * @desc Creates a target pool in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -80133,7 +81120,7 @@ export namespace compute_beta { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project and region. + * @desc Retrieves a list of target pools available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -80277,7 +81264,7 @@ export namespace compute_beta { /** * compute.targetPools.removeHealthCheck - * @desc Removes health check URL from a target pool. + * @desc Removes health check URL from a target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -80415,7 +81402,7 @@ export namespace compute_beta { /** * compute.targetPools.removeInstance - * @desc Removes instance URL from a target pool. + * @desc Removes instance URL from a target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -80553,7 +81540,7 @@ export namespace compute_beta { /** * compute.targetPools.setBackup - * @desc Changes a backup target pool's configurations. + * @desc Changes a backup target pool's configurations. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -80692,7 +81679,7 @@ export namespace compute_beta { /** * compute.targetPools.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -81167,7 +82154,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.delete - * @desc Deletes the specified TargetSslProxy resource. + * @desc Deletes the specified TargetSslProxy resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -81296,7 +82283,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -81424,7 +82411,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -81554,7 +82541,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the specified project. + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -81695,7 +82682,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setBackendService - * @desc Changes the BackendService for TargetSslProxy. + * @desc Changes the BackendService for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -81829,7 +82816,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetSslProxy. + * @desc Changes the ProxyHeaderType for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -81963,7 +82950,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setSslCertificates - * @desc Changes SslCertificates for TargetSslProxy. + * @desc Changes SslCertificates for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -82097,7 +83084,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -82174,7 +83161,7 @@ export namespace compute_beta { /** * compute.targetSslProxies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -82525,7 +83512,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.delete - * @desc Deletes the specified TargetTcpProxy resource. + * @desc Deletes the specified TargetTcpProxy resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -82654,7 +83641,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -82782,7 +83769,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -82912,7 +83899,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -83053,7 +84040,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.setBackendService - * @desc Changes the BackendService for TargetTcpProxy. + * @desc Changes the BackendService for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -83187,7 +84174,7 @@ export namespace compute_beta { /** * compute.targetTcpProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetTcpProxy. + * @desc Changes the ProxyHeaderType for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -83464,7 +84451,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.aggregatedList - * @desc Retrieves an aggregated list of target VPN gateways. + * @desc Retrieves an aggregated list of target VPN gateways. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -83614,7 +84601,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.delete - * @desc Deletes the specified target VPN gateway. + * @desc Deletes the specified target VPN gateway. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -83747,7 +84734,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -83879,7 +84866,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -84013,7 +85000,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified project and region. + * @desc Retrieves a list of target VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -84160,7 +85147,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.setLabels - * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetVpnGateways.setLabels * @memberOf! () * @@ -84238,7 +85225,7 @@ export namespace compute_beta { /** * compute.targetVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -84570,7 +85557,7 @@ export namespace compute_beta { /** * compute.urlMaps.aggregatedList - * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. + * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.aggregatedList * @memberOf! () * @@ -84651,7 +85638,7 @@ export namespace compute_beta { /** * compute.urlMaps.delete - * @desc Deletes the specified UrlMap resource. + * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -84779,7 +85766,7 @@ export namespace compute_beta { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -84904,7 +85891,7 @@ export namespace compute_beta { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -85032,7 +86019,7 @@ export namespace compute_beta { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -85166,7 +86153,7 @@ export namespace compute_beta { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project. + * @desc Retrieves the list of UrlMap resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -85305,7 +86292,7 @@ export namespace compute_beta { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -85439,7 +86426,7 @@ export namespace compute_beta { /** * compute.urlMaps.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -85576,7 +86563,7 @@ export namespace compute_beta { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. + * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -85710,7 +86697,7 @@ export namespace compute_beta { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -86077,7 +87064,7 @@ export namespace compute_beta { /** * compute.vpnGateways.aggregatedList - * @desc Retrieves an aggregated list of VPN gateways. + * @desc Retrieves an aggregated list of VPN gateways. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.aggregatedList * @memberOf! () * @@ -86159,7 +87146,7 @@ export namespace compute_beta { /** * compute.vpnGateways.delete - * @desc Deletes the specified VPN gateway. + * @desc Deletes the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.delete * @memberOf! () * @@ -86236,7 +87223,7 @@ export namespace compute_beta { /** * compute.vpnGateways.get - * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.get * @memberOf! () * @@ -86311,7 +87298,7 @@ export namespace compute_beta { /** * compute.vpnGateways.getStatus - * @desc Returns the status for the specified VPN gateway. + * @desc Returns the status for the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.getStatus * @memberOf! () * @@ -86396,7 +87383,7 @@ export namespace compute_beta { /** * compute.vpnGateways.insert - * @desc Creates a VPN gateway in the specified project and region using the data included in the request. + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.insert * @memberOf! () * @@ -86473,7 +87460,7 @@ export namespace compute_beta { /** * compute.vpnGateways.list - * @desc Retrieves a list of VPN gateways available to the specified project and region. + * @desc Retrieves a list of VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.list * @memberOf! () * @@ -86551,7 +87538,7 @@ export namespace compute_beta { /** * compute.vpnGateways.setLabels - * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.setLabels * @memberOf! () * @@ -86813,7 +87800,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.aggregatedList - * @desc Retrieves an aggregated list of VPN tunnels. + * @desc Retrieves an aggregated list of VPN tunnels. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -86957,7 +87944,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.delete - * @desc Deletes the specified VpnTunnel resource. + * @desc Deletes the specified VpnTunnel resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -87090,7 +88077,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -87221,7 +88208,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -87355,7 +88342,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -87499,7 +88486,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.setLabels - * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnTunnels.setLabels * @memberOf! () * @@ -87577,7 +88564,7 @@ export namespace compute_beta { /** * compute.vpnTunnels.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -87907,7 +88894,7 @@ export namespace compute_beta { /** * compute.zoneOperations.delete - * @desc Deletes the specified zone-specific Operations resource. + * @desc Deletes the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -88034,7 +89021,7 @@ export namespace compute_beta { /** * compute.zoneOperations.get - * @desc Retrieves the specified zone-specific Operations resource. + * @desc Retrieves the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -88166,7 +89153,7 @@ export namespace compute_beta { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the specified zone. + * @desc Retrieves a list of Operation resources contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -88391,7 +89378,7 @@ export namespace compute_beta { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -88515,7 +89502,7 @@ export namespace compute_beta { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified project. + * @desc Retrieves the list of Zone resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 01a215dd0bc..1e7cb1000b0 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -756,9 +756,6 @@ export namespace compute_v1 { * Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. */ exemptedMembers?: string[] | null; - /** - * Specifies whether principals can be exempted for the same LogType in lower-level resource policies. If true, any lower-level exemptions will be ignored. - */ ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. @@ -1115,7 +1112,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * 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 ==) */ export interface Schema$BackendService { /** @@ -1130,7 +1127,15 @@ export namespace compute_v1 { * Cloud CDN configuration for this BackendService. */ cdnPolicy?: Schema$BackendServiceCdnPolicy; + /** + * Settings controlling the volume of connections to a 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. + */ + circuitBreakers?: Schema$CircuitBreakers; connectionDraining?: Schema$ConnectionDraining; + /** + * Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + consistentHash?: Schema$ConsistentHashLoadBalancerSettings; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -1165,13 +1170,21 @@ export namespace compute_v1 { */ kind?: string | null; /** - * Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL. + * Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer. */ loadBalancingScheme?: string | null; + /** + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + */ + localityLbPolicy?: string | 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; + /** + * 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. + */ + outlierDetection?: Schema$OutlierDetection; /** * Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing). */ @@ -1181,7 +1194,7 @@ export namespace compute_v1 { */ portName?: string | null; /** - * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic director for more information. + * The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP, depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information. */ protocol?: string | null; /** @@ -1376,6 +1389,31 @@ export namespace compute_v1 { */ queryStringWhitelist?: string[] | null; } + /** + * Settings controlling the volume of connections to a backend service. + */ + export interface Schema$CircuitBreakers { + /** + * The maximum number of connections to the backend service. If not specified, there is no limit. + */ + maxConnections?: number | null; + /** + * The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. + */ + maxPendingRequests?: number | null; + /** + * The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit. + */ + maxRequests?: number | null; + /** + * Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. + */ + maxRequestsPerConnection?: number | null; + /** + * The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. + */ + 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 ==) */ @@ -1548,6 +1586,77 @@ export namespace compute_v1 { */ drainingTimeoutSec?: number | null; } + /** + * This message defines settings for a consistent hash style load balancer. + */ + export interface Schema$ConsistentHashLoadBalancerSettings { + /** + * Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. + */ + httpCookie?: Schema$ConsistentHashLoadBalancerSettingsHttpCookie; + /** + * The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD. + */ + httpHeaderName?: string | null; + /** + * The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. + */ + minimumRingSize?: string | null; + } + /** + * The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. + */ + export interface Schema$ConsistentHashLoadBalancerSettingsHttpCookie { + /** + * Name of the cookie. + */ + name?: string | null; + /** + * Path to set for the cookie. + */ + path?: string | null; + /** + * Lifetime of the cookie. + */ + ttl?: Schema$Duration; + } + /** + * The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing + */ + export interface Schema$CorsPolicy { + /** + * In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header. Default is false. + */ + allowCredentials?: boolean | null; + /** + * Specifies the content for the Access-Control-Allow-Headers header. + */ + allowHeaders?: string[] | null; + /** + * Specifies the content for the Access-Control-Allow-Methods header. + */ + allowMethods?: string[] | null; + /** + * Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allow_origins or allow_origin_regex. + */ + allowOriginRegexes?: string[] | null; + /** + * Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allow_origins or allow_origin_regex. + */ + allowOrigins?: string[] | null; + /** + * If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect. + */ + disabled?: boolean | null; + /** + * Specifies the content for the Access-Control-Expose-Headers header. + */ + 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. + */ + maxAge?: number | null; + } /** * Represents a customer-supplied encryption key */ @@ -1821,7 +1930,7 @@ export namespace compute_v1 { } export interface Schema$DisksAddResourcePoliciesRequest { /** - * Resource policies to be added to this disk. + * Resource policies to be added to this disk. Currently you can only specify one policy here. */ resourcePolicies?: string[] | null; } @@ -1998,6 +2107,19 @@ export namespace compute_v1 { */ zone?: string | null; } + /** + * A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. + */ + export interface Schema$Duration { + /** + * Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + */ + nanos?: number | null; + /** + * Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + */ + seconds?: string | null; + } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ @@ -2252,7 +2374,7 @@ export namespace compute_v1 { percent?: number | null; } /** - * Represents a Forwarding Rule resource. A forwardingRules resource represents a regional forwarding rule. Regional external forwarding rules can reference any of the following resources: - A target instance - A Cloud VPN Classic gateway (targetVpnGateway), - A target pool for a Network Load Balancer - A global target HTTP(S) proxy for an HTTP(S) load balancer using Standard Tier - A target SSL proxy for a SSL Proxy load balancer using Standard Tier - A target TCP proxy for a TCP Proxy load balancer using Standard Tier. Regional internal forwarding rules can reference the backend service of an internal TCP/UDP load balancer. For regional internal forwarding rules, the following applies: - If the loadBalancingScheme for the load balancer is INTERNAL, then the forwarding rule references a regional internal backend service. - If the loadBalancingScheme for the load balancer is INTERNAL_MANAGED, then the forwarding rule must reference a regional target HTTP(S) proxy. For more information, read Using Forwarding rules. A globalForwardingRules resource represents a global forwarding rule. Global forwarding rules are only used by load balancers that use Premium Tier. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * 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 ==) */ export interface Schema$ForwardingRule { /** @@ -2280,7 +2402,7 @@ export namespace compute_v1 { */ IPAddress?: string | null; /** - * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. + * The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid. */ IPProtocol?: string | null; /** @@ -2292,9 +2414,13 @@ export namespace compute_v1 { */ kind?: string | null; /** - * This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + * 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; + /** + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. + */ + metadataFilters?: Schema$MetadataFilter[]; /** * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ @@ -2729,6 +2855,120 @@ export namespace compute_v1 { */ response?: string | null; } + /** + * Specification for how requests are aborted as part of fault injection. + */ + export interface Schema$HttpFaultAbort { + /** + * The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. + */ + httpStatus?: number | null; + /** + * The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive. + */ + percentage?: number | null; + } + /** + * Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. + */ + export interface Schema$HttpFaultDelay { + /** + * Specifies the value of the fixed delay interval. + */ + fixedDelay?: Schema$Duration; + /** + * The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive. + */ + percentage?: number | null; + } + /** + * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. + */ + export interface Schema$HttpFaultInjection { + /** + * The specification for how client requests are aborted as part of fault injection. + */ + abort?: Schema$HttpFaultAbort; + /** + * The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. + */ + delay?: Schema$HttpFaultDelay; + } + /** + * The request and response header transformations that take effect before the request is passed along to the selected backendService. + */ + export interface Schema$HttpHeaderAction { + /** + * Headers to add to a matching request prior to forwarding the request to the backendService. + */ + requestHeadersToAdd?: Schema$HttpHeaderOption[]; + /** + * A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService. + */ + requestHeadersToRemove?: string[] | null; + /** + * Headers to add the response prior to sending the response back to the client. + */ + responseHeadersToAdd?: Schema$HttpHeaderOption[]; + /** + * A list of header names for headers that need to be removed from the response prior to sending the response back to the client. + */ + responseHeadersToRemove?: string[] | null; + } + /** + * matchRule criteria for request header matches. + */ + export interface Schema$HttpHeaderMatch { + /** + * The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + exactMatch?: string | null; + /** + * The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". + */ + headerName?: string | null; + /** + * If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false. + */ + invertMatch?: boolean | null; + /** + * The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + prefixMatch?: string | null; + /** + * A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value or not. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + presentMatch?: boolean | 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. + */ + rangeMatch?: Schema$Int64RangeMatch; + /** + * The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + regexMatch?: string | null; + /** + * The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + */ + suffixMatch?: string | null; + } + /** + * Specification determining how headers are added to requests or responses. + */ + export interface Schema$HttpHeaderOption { + /** + * The name of the header. + */ + headerName?: string | null; + /** + * The value of the header to add. + */ + headerValue?: string | null; + /** + * If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. + */ + replace?: boolean | null; + } export interface Schema$HTTPHealthCheck { /** * The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used. @@ -2850,61 +3090,164 @@ export namespace compute_v1 { } | null; } /** - * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. + * HttpRouteRuleMatch criteria for a request's query parameter. */ - export interface Schema$HttpsHealthCheck { + export interface Schema$HttpQueryParameterMatch { /** - * How often (in seconds) to send a health check. The default value is 5 seconds. + * The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch and regexMatch must be set. */ - checkIntervalSec?: number | null; + exactMatch?: string | null; /** - * [Output Only] Creation timestamp in RFC3339 text format. + * The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails. */ - creationTimestamp?: string | null; + name?: string | null; /** - * An optional description of this resource. Provide this property when you create the resource. + * Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch and regexMatch must be set. + */ + presentMatch?: boolean | 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 and regexMatch must be set. + */ + regexMatch?: string | null; + } + /** + * Specifies settings for an HTTP redirect. + */ + export interface Schema$HttpRedirectAction { + /** + * The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. + */ + hostRedirect?: string | null; + /** + * If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. + */ + httpsRedirect?: boolean | 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. + */ + pathRedirect?: string | null; + /** + * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. + */ + prefixRedirect?: string | null; + /** + * The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. + */ + redirectResponseCode?: string | null; + /** + * If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. + */ + stripQuery?: boolean | null; + } + /** + * The retry policy associates with HttpRouteRule + */ + export interface Schema$HttpRetryPolicy { + /** + * Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. + */ + numRetries?: number | null; + /** + * Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route. + */ + perTryTimeout?: Schema$Duration; + /** + * Specfies one or more conditions when this retry rule applies. Valid values are: - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable + */ + retryConditions?: string[] | null; + } + export interface Schema$HttpRouteAction { + /** + * The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing + */ + corsPolicy?: Schema$CorsPolicy; + /** + * The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy. + */ + faultInjectionPolicy?: Schema$HttpFaultInjection; + /** + * Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. + */ + requestMirrorPolicy?: Schema$RequestMirrorPolicy; + /** + * Specifies the retry policy associated with this route. + */ + retryPolicy?: Schema$HttpRetryPolicy; + /** + * Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, will use the largest timeout among all backend services associated with the route. + */ + timeout?: Schema$Duration; + /** + * The spec to modify the URL of the request, prior to forwarding the request to the matched service + */ + urlRewrite?: Schema$UrlRewrite; + /** + * A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. + */ + weightedBackendServices?: Schema$WeightedBackendService[]; + } + /** + * An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform. + */ + export interface Schema$HttpRouteRule { + /** + * The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. */ description?: string | null; /** - * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. + * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction */ - healthyThreshold?: number | null; + headerAction?: Schema$HttpHeaderAction; + matchRules?: Schema$HttpRouteRuleMatch[]; /** - * The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. + * For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules. */ - host?: string | null; + priority?: number | null; /** - * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + * In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. */ - id?: string | null; + routeAction?: Schema$HttpRouteAction; /** - * Type of the resource. + * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ - kind?: string | null; + service?: 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. + * When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. */ - name?: string | null; + urlRedirect?: Schema$HttpRedirectAction; + } + /** + * HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur. + */ + export interface Schema$HttpRouteRuleMatch { /** - * The TCP port number for the HTTPS health check request. The default value is 443. + * For satifying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. FullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ - port?: number | null; + fullPathMatch?: string | null; /** - * The request path of the HTTPS health check request. The default value is "/". + * Specifies a list of header match criteria, all of which must match corresponding headers in the request. */ - requestPath?: string | null; + headerMatches?: Schema$HttpHeaderMatch[]; /** - * [Output Only] Server-defined URL for the resource. + * Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. caseSensitive must not be used with regexMatch. */ - selfLink?: string | null; + ignoreCase?: boolean | null; /** - * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. + * Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overrides those specified in ForwardingRule that refers to this UrlMap. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ - timeoutSec?: number | null; + metadataFilters?: Schema$MetadataFilter[]; /** - * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. + * For satifying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. */ - unhealthyThreshold?: number | null; + prefixMatch?: string | null; + /** + * Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. + */ + queryParameterMatches?: Schema$HttpQueryParameterMatch[]; + /** + * For satifying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + */ + regexMatch?: string | null; } export interface Schema$HTTPSHealthCheck { /** @@ -2936,6 +3279,63 @@ export namespace compute_v1 { */ response?: string | null; } + /** + * Represents a legacy HTTPS Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts. + */ + export interface Schema$HttpsHealthCheck { + /** + * How often (in seconds) to send a health check. The default value is 5 seconds. + */ + checkIntervalSec?: number | null; + /** + * [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; + /** + * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. + */ + healthyThreshold?: number | null; + /** + * The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. + */ + host?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * Type of the resource. + */ + 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; + /** + * The TCP port number for the HTTPS health check request. The default value is 443. + */ + port?: number | null; + /** + * The request path of the HTTPS health check request. The default value is "/". + */ + requestPath?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. + */ + timeoutSec?: number | null; + /** + * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. + */ + unhealthyThreshold?: number | null; + } /** * Contains a list of HttpsHealthCheck resources. */ @@ -4032,6 +4432,19 @@ export namespace compute_v1 { */ status?: string | null; } + /** + * HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. + */ + export interface Schema$Int64RangeMatch { + /** + * The end of the range (exclusive) in signed long integer format. + */ + rangeEnd?: string | null; + /** + * The start of the range (inclusive) in signed long integer format. + */ + 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 ==) */ @@ -4771,9 +5184,13 @@ export namespace compute_v1 { logName?: 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/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). + * 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]} TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields in the same counter. */ export interface Schema$LogConfigCounterOptions { + /** + * Custom fields. + */ + customFields?: Schema$LogConfigCounterOptionsCustomField[]; /** * The field value to attribute. */ @@ -4783,6 +5200,19 @@ export namespace compute_v1 { */ 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$LogConfigCounterOptionsCustomField { + /** + * 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 */ @@ -4998,6 +5428,32 @@ export namespace compute_v1 { */ kind?: string | null; } + /** + * Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers. + */ + export interface Schema$MetadataFilter { + /** + * The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. + */ + filterLabels?: Schema$MetadataFilterLabelMatch[]; + /** + * Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata. + */ + filterMatchCriteria?: string | null; + } + /** + * MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer. + */ + export interface Schema$MetadataFilterLabelMatch { + /** + * Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long. + */ + name?: string | null; + /** + * The value of the label must match the specified value. value can have a maximum length of 1024 characters. + */ + value?: string | null; + } /** * The named port. For example: . */ @@ -6040,26 +6496,91 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. + */ + export interface Schema$OutlierDetection { + /** + * The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. + */ + baseEjectionTime?: Schema$Duration; + /** + * Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + */ + consecutiveErrors?: number | null; + /** + * The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3. + */ + consecutiveGatewayFailure?: number | null; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0. + */ + enforcingConsecutiveErrors?: number | null; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + */ + enforcingConsecutiveGatewayFailure?: number | null; + /** + * The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. + */ + enforcingSuccessRate?: number | null; + /** + * Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 seconds. + */ + interval?: Schema$Duration; + /** + * Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%. + */ + maxEjectionPercent?: number | null; + /** + * The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5. + */ + successRateMinimumHosts?: number | null; + /** + * The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100. + */ + successRateRequestVolume?: number | null; + /** + * This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. + */ + successRateStdevFactor?: number | 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. */ export interface Schema$PathMatcher { + /** + * defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. + */ + defaultRouteAction?: Schema$HttpRouteAction; /** * The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use */ defaultService?: string | null; + /** + * When when none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + */ + defaultUrlRedirect?: Schema$HttpRedirectAction; /** * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap + */ + headerAction?: Schema$HttpHeaderAction; /** * The name to which this PathMatcher is referred by the HostRule. */ name?: string | null; /** - * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. + * The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. */ pathRules?: Schema$PathRule[]; + /** + * The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. + */ + routeRules?: Schema$HttpRouteRule[]; } /** * A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. @@ -6069,13 +6590,21 @@ export namespace compute_v1 { * The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. */ paths?: string[] | null; + /** + * In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. + */ + routeAction?: Schema$HttpRouteAction; /** * The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. */ service?: string | null; + /** + * When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. + */ + urlRedirect?: Schema$HttpRedirectAction; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -6083,11 +6612,11 @@ export namespace compute_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; iamOwned?: boolean | null; @@ -6096,7 +6625,7 @@ export namespace compute_v1 { */ rules?: Schema$Rule[]; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -6588,6 +7117,15 @@ export namespace compute_v1 { */ resource?: Schema$UrlMap; } + /** + * A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. + */ + export interface Schema$RequestMirrorPolicy { + /** + * The full or partial URL to the BackendService resource being mirrored to. + */ + backendService?: string | 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 ==) */ @@ -7019,6 +7557,10 @@ export namespace compute_v1 { * The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway */ nextHopGateway?: string | null; + /** + * The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule + */ + nextHopIlb?: string | null; /** * The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ */ @@ -7311,6 +7853,10 @@ export namespace compute_v1 { * Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided. */ export interface Schema$RouterNat { + /** + * A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only. + */ + drainNatIps?: string[] | null; /** * Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. */ @@ -7472,6 +8018,14 @@ export namespace compute_v1 { * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] */ autoAllocatedNatIps?: string[] | null; + /** + * A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", ?179.12.26.133?]. + */ + drainAutoAllocatedNatIps?: string[] | null; + /** + * A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", ?179.12.26.133?]. + */ + drainUserAllocatedNatIps?: string[] | null; /** * The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used. */ @@ -8529,7 +9083,7 @@ export namespace compute_v1 { */ name?: string | null; /** - * Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE. + * Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. - */ quicOverride?: string | null; /** @@ -8545,7 +9099,7 @@ export namespace compute_v1 { */ sslCertificates?: string[] | null; /** - * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured. + * URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. */ sslPolicy?: string | null; /** @@ -9254,10 +9808,18 @@ export namespace compute_v1 { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; + /** + * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. + */ + defaultRouteAction?: Schema$HttpRouteAction; /** * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. */ defaultService?: string | null; + /** + * When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. + */ + defaultUrlRedirect?: Schema$HttpRedirectAction; /** * An optional description of this resource. Provide this property when you create the resource. */ @@ -9266,6 +9828,10 @@ export namespace compute_v1 { * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. */ fingerprint?: string | null; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. + */ + headerAction?: Schema$HttpHeaderAction; /** * The list of HostRules to use against the URL. */ @@ -9424,6 +9990,19 @@ export namespace compute_v1 { */ testPassed?: boolean | null; } + /** + * The spec for modifying the path before sending the request to the matched backend service. + */ + export interface Schema$UrlRewrite { + /** + * Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters. + */ + hostRewrite?: string | null; + /** + * Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters. + */ + pathPrefixRewrite?: string | null; + } /** * Subnetwork which the current user has compute.subnetworks.use permission on. */ @@ -9515,10 +10094,18 @@ export namespace compute_v1 { * Contain information of Nat mapping for an interface of this endpoint. */ export interface Schema$VmEndpointNatMappingsInterfaceNatMappings { + /** + * List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. + */ + drainNatIpPortRanges?: string[] | null; /** * A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"]. */ natIpPortRanges?: string[] | null; + /** + * Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges. + */ + numTotalDrainNatPorts?: number | null; /** * Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges. */ @@ -9841,7 +10428,7 @@ export namespace compute_v1 { */ sharedSecretHash?: string | null; /** - * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. + * [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being blacklisted. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. */ status?: string | null; /** @@ -9934,6 +10521,23 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService + */ + export interface Schema$WeightedBackendService { + /** + * The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight. + */ + backendService?: string | null; + /** + * Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. + */ + headerAction?: Schema$HttpHeaderAction; + /** + * Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy. The value must be between 0 and 1000 + */ + weight?: number | null; + } export interface Schema$XpnHostList { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -10088,7 +10692,7 @@ export namespace compute_v1 { /** * compute.acceleratorTypes.aggregatedList - * @desc Retrieves an aggregated list of accelerator types. + * @desc Retrieves an aggregated list of accelerator types. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -10238,7 +10842,7 @@ export namespace compute_v1 { /** * compute.acceleratorTypes.get - * @desc Returns the specified accelerator type. + * @desc Returns the specified accelerator type. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -10370,7 +10974,7 @@ export namespace compute_v1 { /** * compute.acceleratorTypes.list - * @desc Retrieves a list of accelerator types available to the specified project. + * @desc Retrieves a list of accelerator types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -10603,7 +11207,7 @@ export namespace compute_v1 { /** * compute.addresses.aggregatedList - * @desc Retrieves an aggregated list of addresses. + * @desc Retrieves an aggregated list of addresses. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -10747,7 +11351,7 @@ export namespace compute_v1 { /** * compute.addresses.delete - * @desc Deletes the specified address resource. + * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -10879,7 +11483,7 @@ export namespace compute_v1 { /** * compute.addresses.get - * @desc Returns the specified address resource. + * @desc Returns the specified address resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11008,7 +11612,7 @@ export namespace compute_v1 { /** * compute.addresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11141,7 +11745,7 @@ export namespace compute_v1 { /** * compute.addresses.list - * @desc Retrieves a list of addresses contained within the specified region. + * @desc Retrieves a list of addresses contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11418,7 +12022,7 @@ export namespace compute_v1 { /** * compute.autoscalers.aggregatedList - * @desc Retrieves an aggregated list of autoscalers. + * @desc Retrieves an aggregated list of autoscalers. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11562,7 +12166,7 @@ export namespace compute_v1 { /** * compute.autoscalers.delete - * @desc Deletes the specified autoscaler. + * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11695,7 +12299,7 @@ export namespace compute_v1 { /** * compute.autoscalers.get - * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. + * @desc Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11826,7 +12430,7 @@ export namespace compute_v1 { /** * compute.autoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -11960,7 +12564,7 @@ export namespace compute_v1 { /** * compute.autoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified zone. + * @desc Retrieves a list of autoscalers contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12104,7 +12708,7 @@ export namespace compute_v1 { /** * compute.autoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12240,7 +12844,7 @@ export namespace compute_v1 { /** * compute.autoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12569,7 +13173,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend bucket. + * @desc Adds a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -12646,7 +13250,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.delete - * @desc Deletes the specified BackendBucket resource. + * @desc Deletes the specified BackendBucket resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12775,7 +13379,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend bucket. + * @desc Deletes a key for validating requests with signed URLs for this backend bucket. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -12852,7 +13456,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.get - * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. + * @desc Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -12980,7 +13584,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.insert - * @desc Creates a BackendBucket resource in the specified project using the data included in the request. + * @desc Creates a BackendBucket resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13109,7 +13713,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.list - * @desc Retrieves the list of BackendBucket resources available to the specified project. + * @desc Retrieves the list of BackendBucket resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13249,7 +13853,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.patch - * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13384,7 +13988,7 @@ export namespace compute_v1 { /** * compute.backendBuckets.update - * @desc Updates the specified BackendBucket resource with the data included in the request. + * @desc Updates the specified BackendBucket resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13711,7 +14315,7 @@ export namespace compute_v1 { /** * compute.backendServices.addSignedUrlKey - * @desc Adds a key for validating requests with signed URLs for this backend service. + * @desc Adds a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -13788,7 +14392,7 @@ export namespace compute_v1 { /** * compute.backendServices.aggregatedList - * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. + * @desc Retrieves the list of all BackendService resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -13938,7 +14542,7 @@ export namespace compute_v1 { /** * compute.backendServices.delete - * @desc Deletes the specified BackendService resource. + * @desc Deletes the specified BackendService resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14067,7 +14671,7 @@ export namespace compute_v1 { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes a key for validating requests with signed URLs for this backend service. + * @desc Deletes a key for validating requests with signed URLs for this backend service. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -14144,7 +14748,7 @@ export namespace compute_v1 { /** * compute.backendServices.get - * @desc Returns the specified BackendService resource. Gets a list of available backend services. + * @desc Returns the specified BackendService resource. Gets a list of available backend services. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14272,7 +14876,7 @@ export namespace compute_v1 { /** * compute.backendServices.getHealth - * @desc Gets the most recent health check results for this BackendService. + * @desc Gets the most recent health check results for this BackendService. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14411,7 +15015,7 @@ export namespace compute_v1 { /** * compute.backendServices.insert - * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. + * @desc Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14540,7 +15144,7 @@ export namespace compute_v1 { /** * compute.backendServices.list - * @desc Retrieves the list of BackendService resources available to the specified project. + * @desc Retrieves the list of BackendService resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14680,7 +15284,7 @@ export namespace compute_v1 { /** * compute.backendServices.patch - * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -14815,7 +15419,7 @@ export namespace compute_v1 { /** * compute.backendServices.setSecurityPolicy - * @desc Sets the security policy for the specified backend service. + * @desc Sets the security policy for the specified backend service. (== suppress_warning http-rest-shadowed ==) * @alias compute.backendServices.setSecurityPolicy * @memberOf! () * @@ -14892,7 +15496,7 @@ export namespace compute_v1 { /** * compute.backendServices.update - * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. + * @desc Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15293,7 +15897,7 @@ export namespace compute_v1 { /** * compute.disks.addResourcePolicies - * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * @desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.addResourcePolicies * @memberOf! () * @@ -15371,7 +15975,7 @@ export namespace compute_v1 { /** * compute.disks.aggregatedList - * @desc Retrieves an aggregated list of persistent disks. + * @desc Retrieves an aggregated list of persistent disks. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15513,7 +16117,7 @@ export namespace compute_v1 { /** * compute.disks.createSnapshot - * @desc Creates a snapshot of a specified persistent disk. + * @desc Creates a snapshot of a specified persistent disk. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15652,7 +16256,7 @@ export namespace compute_v1 { /** * compute.disks.delete - * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15784,7 +16388,7 @@ export namespace compute_v1 { /** * compute.disks.get - * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. + * @desc Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -15913,7 +16517,7 @@ export namespace compute_v1 { /** * compute.disks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.getIamPolicy * @memberOf! () * @@ -15987,7 +16591,7 @@ export namespace compute_v1 { /** * compute.disks.insert - * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. + * @desc Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16120,7 +16724,7 @@ export namespace compute_v1 { /** * compute.disks.list - * @desc Retrieves a list of persistent disks contained within the specified zone. + * @desc Retrieves a list of persistent disks contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16261,7 +16865,7 @@ export namespace compute_v1 { /** * compute.disks.removeResourcePolicies - * @desc Removes resource policies from a disk. + * @desc Removes resource policies from a disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.removeResourcePolicies * @memberOf! () * @@ -16341,7 +16945,7 @@ export namespace compute_v1 { /** * compute.disks.resize - * @desc Resizes the specified persistent disk. You can only increase the size of the disk. + * @desc Resizes the specified persistent disk. You can only increase the size of the disk. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16478,7 +17082,7 @@ export namespace compute_v1 { /** * compute.disks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.setIamPolicy * @memberOf! () * @@ -16553,7 +17157,7 @@ export namespace compute_v1 { /** * compute.disks.setLabels - * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -16690,7 +17294,7 @@ export namespace compute_v1 { /** * compute.disks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.disks.testIamPermissions * @memberOf! () * @@ -17125,7 +17729,7 @@ export namespace compute_v1 { /** * compute.diskTypes.aggregatedList - * @desc Retrieves an aggregated list of disk types. + * @desc Retrieves an aggregated list of disk types. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -17269,7 +17873,7 @@ export namespace compute_v1 { /** * compute.diskTypes.get - * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. + * @desc Returns the specified disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -17398,7 +18002,7 @@ export namespace compute_v1 { /** * compute.diskTypes.list - * @desc Retrieves a list of disk types available to the specified project. + * @desc Retrieves a list of disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -17627,7 +18231,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.delete - * @desc Deletes the specified externalVpnGateway. + * @desc Deletes the specified externalVpnGateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.delete * @memberOf! () * @@ -17703,7 +18307,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.get - * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. + * @desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.get * @memberOf! () * @@ -17778,7 +18382,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.insert - * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. + * @desc Creates a ExternalVpnGateway in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.insert * @memberOf! () * @@ -17854,7 +18458,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.list - * @desc Retrieves the list of ExternalVpnGateway available to the specified project. + * @desc Retrieves the list of ExternalVpnGateway available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.list * @memberOf! () * @@ -17934,7 +18538,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.setLabels - * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.setLabels * @memberOf! () * @@ -18010,7 +18614,7 @@ export namespace compute_v1 { /** * compute.externalVpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.externalVpnGateways.testIamPermissions * @memberOf! () * @@ -18225,7 +18829,7 @@ export namespace compute_v1 { /** * compute.firewalls.delete - * @desc Deletes the specified firewall. + * @desc Deletes the specified firewall. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18353,7 +18957,7 @@ export namespace compute_v1 { /** * compute.firewalls.get - * @desc Returns the specified firewall. + * @desc Returns the specified firewall. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18478,7 +19082,7 @@ export namespace compute_v1 { /** * compute.firewalls.insert - * @desc Creates a firewall rule in the specified project using the data included in the request. + * @desc Creates a firewall rule in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18606,7 +19210,7 @@ export namespace compute_v1 { /** * compute.firewalls.list - * @desc Retrieves the list of firewall rules available to the specified project. + * @desc Retrieves the list of firewall rules available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18745,7 +19349,7 @@ export namespace compute_v1 { /** * compute.firewalls.patch - * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -18879,7 +19483,7 @@ export namespace compute_v1 { /** * compute.firewalls.update - * @desc Updates the specified firewall rule with the data included in the request. The PUT method can only update the following fields of firewall rule: allowed, description, sourceRanges, sourceTags, targetTags. + * @desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19150,7 +19754,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.aggregatedList - * @desc Retrieves an aggregated list of forwarding rules. + * @desc Retrieves an aggregated list of forwarding rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19300,7 +19904,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.delete - * @desc Deletes the specified ForwardingRule resource. + * @desc Deletes the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19433,7 +20037,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.get - * @desc Returns the specified ForwardingRule resource. + * @desc Returns the specified ForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19565,7 +20169,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.insert - * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. + * @desc Creates a ForwardingRule resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19699,7 +20303,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.list - * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. + * @desc Retrieves a list of ForwardingRule resources available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -19844,7 +20448,7 @@ export namespace compute_v1 { /** * compute.forwardingRules.setTarget - * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. + * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20148,7 +20752,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.delete - * @desc Deletes the specified address resource. + * @desc Deletes the specified address resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20277,7 +20881,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.get - * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. + * @desc Returns the specified address resource. Gets a list of available addresses by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20403,7 +21007,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.insert - * @desc Creates an address resource in the specified project by using the data included in the request. + * @desc Creates an address resource in the specified project by using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20532,7 +21136,7 @@ export namespace compute_v1 { /** * compute.globalAddresses.list - * @desc Retrieves a list of global addresses. + * @desc Retrieves a list of global addresses. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20765,7 +21369,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.delete - * @desc Deletes the specified GlobalForwardingRule resource. + * @desc Deletes the specified GlobalForwardingRule resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -20894,7 +21498,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.get - * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. + * @desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21022,7 +21626,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.insert - * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. + * @desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21151,7 +21755,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.list - * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. + * @desc Retrieves a list of GlobalForwardingRule resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21291,7 +21895,7 @@ export namespace compute_v1 { /** * compute.globalForwardingRules.setTarget - * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. + * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21543,7 +22147,7 @@ export namespace compute_v1 { /** * compute.globalOperations.aggregatedList - * @desc Retrieves an aggregated list of all operations. + * @desc Retrieves an aggregated list of all operations. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21687,7 +22291,7 @@ export namespace compute_v1 { /** * compute.globalOperations.delete - * @desc Deletes the specified Operations resource. + * @desc Deletes the specified Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21810,7 +22414,7 @@ export namespace compute_v1 { /** * compute.globalOperations.get - * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. + * @desc Retrieves the specified Operations resource. Gets a list of operations by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -21938,7 +22542,7 @@ export namespace compute_v1 { /** * compute.globalOperations.list - * @desc Retrieves a list of Operation resources contained within the specified project. + * @desc Retrieves a list of Operation resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22174,7 +22778,7 @@ export namespace compute_v1 { /** * compute.healthChecks.aggregatedList - * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. + * @desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.healthChecks.aggregatedList * @memberOf! () * @@ -22258,7 +22862,7 @@ export namespace compute_v1 { /** * compute.healthChecks.delete - * @desc Deletes the specified HealthCheck resource. + * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22387,7 +22991,7 @@ export namespace compute_v1 { /** * compute.healthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22514,7 +23118,7 @@ export namespace compute_v1 { /** * compute.healthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22643,7 +23247,7 @@ export namespace compute_v1 { /** * compute.healthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22783,7 +23387,7 @@ export namespace compute_v1 { /** * compute.healthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -22918,7 +23522,7 @@ export namespace compute_v1 { /** * compute.healthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23223,7 +23827,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.delete - * @desc Deletes the specified HttpHealthCheck resource. + * @desc Deletes the specified HttpHealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23352,7 +23956,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.get - * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. + * @desc Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23480,7 +24084,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.insert - * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23609,7 +24213,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.list - * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. + * @desc Retrieves the list of HttpHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23749,7 +24353,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.patch - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -23884,7 +24488,7 @@ export namespace compute_v1 { /** * compute.httpHealthChecks.update - * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24162,7 +24766,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.delete - * @desc Deletes the specified HttpsHealthCheck resource. + * @desc Deletes the specified HttpsHealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24291,7 +24895,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.get - * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. + * @desc Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24419,7 +25023,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.insert - * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24549,7 +25153,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.list - * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. + * @desc Retrieves the list of HttpsHealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24692,7 +25296,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.patch - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -24827,7 +25431,7 @@ export namespace compute_v1 { /** * compute.httpsHealthChecks.update - * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25105,7 +25709,7 @@ export namespace compute_v1 { /** * compute.images.delete - * @desc Deletes the specified image. + * @desc Deletes the specified image. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25232,7 +25836,7 @@ export namespace compute_v1 { /** * compute.images.deprecate - * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. + * @desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25365,7 +25969,7 @@ export namespace compute_v1 { /** * compute.images.get - * @desc Returns the specified image. Gets a list of available images by making a list() request. + * @desc Returns the specified image. Gets a list of available images by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25489,7 +26093,7 @@ export namespace compute_v1 { /** * compute.images.getFromFamily - * @desc Returns the latest image that is part of an image family and is not deprecated. + * @desc Returns the latest image that is part of an image family and is not deprecated. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25615,7 +26219,7 @@ export namespace compute_v1 { /** * compute.images.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.getIamPolicy * @memberOf! () * @@ -25688,7 +26292,7 @@ export namespace compute_v1 { /** * compute.images.insert - * @desc Creates an image in the specified project using the data included in the request. + * @desc Creates an image in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25817,7 +26421,7 @@ export namespace compute_v1 { /** * compute.images.list - * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -25956,7 +26560,7 @@ export namespace compute_v1 { /** * compute.images.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.setIamPolicy * @memberOf! () * @@ -26030,7 +26634,7 @@ export namespace compute_v1 { /** * compute.images.setLabels - * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26162,7 +26766,7 @@ export namespace compute_v1 { /** * compute.images.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.images.testIamPermissions * @memberOf! () * @@ -26453,7 +27057,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26591,7 +27195,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.aggregatedList - * @desc Retrieves the list of managed instance groups and groups them by zone. + * @desc Retrieves the list of managed instance groups and groups them by zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26741,7 +27345,7 @@ 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -26874,7 +27478,7 @@ 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27012,7 +27616,7 @@ 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. + * @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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27146,7 +27750,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27280,7 +27884,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.list - * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. + * @desc Retrieves a list of managed instance groups that are contained within the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27427,7 +28031,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.listManagedInstances - * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. + * @desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27587,7 +28191,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceGroupManagers.patch * @memberOf! () * @@ -27665,7 +28269,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27803,7 +28407,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.resize - * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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. + * @desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. 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. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -27942,7 +28546,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.setInstanceTemplate - * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. + * @desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28080,7 +28684,7 @@ export namespace compute_v1 { /** * compute.instanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. + * @desc Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28593,7 +29197,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.addInstances - * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. + * @desc Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28731,7 +29335,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.aggregatedList - * @desc Retrieves the list of instance groups and sorts them by zone. + * @desc Retrieves the list of instance groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -28879,7 +29483,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.delete - * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. + * @desc Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29012,7 +29616,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.get - * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. + * @desc Returns the specified instance group. Gets a list of available instance groups by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29144,7 +29748,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.insert - * @desc Creates an instance group in the specified project using the parameters that are included in the request. + * @desc Creates an instance group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29278,7 +29882,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.list - * @desc Retrieves the list of instance groups that are located in the specified project and zone. + * @desc Retrieves the list of instance groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29423,7 +30027,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.listInstances - * @desc Lists the instances in the specified instance group. + * @desc Lists the instances in the specified instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29584,7 +30188,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.removeInstances - * @desc Removes one or more instances from the specified instance group, but does not delete those instances. 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 before the VM instance is removed or deleted. + * @desc Removes one or more instances from the specified instance group, but does not delete those instances. 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 before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -29722,7 +30326,7 @@ export namespace compute_v1 { /** * compute.instanceGroups.setNamedPorts - * @desc Sets the named ports for the specified instance group. + * @desc Sets the named ports for the specified instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30125,7 +30729,7 @@ export namespace compute_v1 { /** * compute.instances.addAccessConfig - * @desc Adds an access config to an instance's network interface. + * @desc Adds an access config to an instance's network interface. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30267,7 +30871,7 @@ export namespace compute_v1 { /** * compute.instances.aggregatedList - * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. + * @desc Retrieves aggregated list of all of the instances in your project across all regions and zones. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30411,7 +31015,7 @@ export namespace compute_v1 { /** * compute.instances.attachDisk - * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. + * @desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30550,7 +31154,7 @@ export namespace compute_v1 { /** * compute.instances.delete - * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. + * @desc Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30682,7 +31286,7 @@ export namespace compute_v1 { /** * compute.instances.deleteAccessConfig - * @desc Deletes an access config from an instance's network interface. + * @desc Deletes an access config from an instance's network interface. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30829,7 +31433,7 @@ export namespace compute_v1 { /** * compute.instances.detachDisk - * @desc Detaches a disk from an instance. + * @desc Detaches a disk from an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -30966,7 +31570,7 @@ export namespace compute_v1 { /** * compute.instances.get - * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. + * @desc Returns the specified Instance resource. Gets a list of available instances by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31095,7 +31699,7 @@ export namespace compute_v1 { /** * compute.instances.getGuestAttributes - * @desc Returns the specified guest attributes entry. + * @desc Returns the specified guest attributes entry. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getGuestAttributes * @memberOf! () * @@ -31175,7 +31779,7 @@ export namespace compute_v1 { /** * compute.instances.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getIamPolicy * @memberOf! () * @@ -31249,7 +31853,7 @@ export namespace compute_v1 { /** * compute.instances.getSerialPortOutput - * @desc Returns the last 1 MB of serial port output from the specified instance. + * @desc Returns the last 1 MB of serial port output from the specified instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31385,7 +31989,7 @@ export namespace compute_v1 { /** * compute.instances.getShieldedInstanceIdentity - * @desc Returns the Shielded Instance Identity of an instance + * @desc Returns the Shielded Instance Identity of an instance (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.getShieldedInstanceIdentity * @memberOf! () * @@ -31465,7 +32069,7 @@ export namespace compute_v1 { /** * compute.instances.insert - * @desc Creates an instance resource in the specified project using the data included in the request. + * @desc Creates an instance resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31598,7 +32202,7 @@ export namespace compute_v1 { /** * compute.instances.list - * @desc Retrieves the list of instances contained within the specified zone. + * @desc Retrieves the list of instances contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31741,7 +32345,7 @@ export namespace compute_v1 { /** * compute.instances.listReferrers - * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. + * @desc Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.listReferrers * @memberOf! () * @@ -31825,7 +32429,7 @@ export namespace compute_v1 { /** * compute.instances.reset - * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. + * @desc Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -31957,7 +32561,7 @@ export namespace compute_v1 { /** * compute.instances.setDeletionProtection - * @desc Sets deletion protection on the instance. + * @desc Sets deletion protection on the instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32093,7 +32697,7 @@ export namespace compute_v1 { /** * compute.instances.setDiskAutoDelete - * @desc Sets the auto-delete flag for a disk attached to an instance. + * @desc Sets the auto-delete flag for a disk attached to an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32240,7 +32844,7 @@ export namespace compute_v1 { /** * compute.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setIamPolicy * @memberOf! () * @@ -32315,7 +32919,7 @@ export namespace compute_v1 { /** * compute.instances.setLabels - * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32453,7 +33057,7 @@ export namespace compute_v1 { /** * compute.instances.setMachineResources - * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. + * @desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32591,7 +33195,7 @@ export namespace compute_v1 { /** * compute.instances.setMachineType - * @desc Changes the machine type for a stopped instance to the machine type specified in the request. + * @desc Changes the machine type for a stopped instance to the machine type specified in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32729,7 +33333,7 @@ export namespace compute_v1 { /** * compute.instances.setMetadata - * @desc Sets metadata for the specified instance to the data included in the request. + * @desc Sets metadata for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -32867,7 +33471,7 @@ export namespace compute_v1 { /** * compute.instances.setMinCpuPlatform - * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. + * @desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33005,7 +33609,7 @@ export namespace compute_v1 { /** * compute.instances.setScheduling - * @desc Sets an instance's scheduling options. + * @desc Sets an instance's scheduling options. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33143,7 +33747,7 @@ export namespace compute_v1 { /** * compute.instances.setServiceAccount - * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. + * @desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33281,7 +33885,7 @@ export namespace compute_v1 { /** * compute.instances.setShieldedInstanceIntegrityPolicy - * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.setShieldedInstanceIntegrityPolicy * @memberOf! () * @@ -33361,7 +33965,7 @@ export namespace compute_v1 { /** * compute.instances.setTags - * @desc Sets network tags for the specified instance to the data included in the request. + * @desc Sets network tags for the specified instance to the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33499,7 +34103,7 @@ export namespace compute_v1 { /** * compute.instances.simulateMaintenanceEvent - * @desc Simulates a maintenance event on the instance. + * @desc Simulates a maintenance event on the instance. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.simulateMaintenanceEvent * @memberOf! () * @@ -33577,7 +34181,7 @@ export namespace compute_v1 { /** * compute.instances.start - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33709,7 +34313,7 @@ export namespace compute_v1 { /** * compute.instances.startWithEncryptionKey - * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. + * @desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33849,7 +34453,7 @@ export namespace compute_v1 { /** * compute.instances.stop - * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. + * @desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -33981,7 +34585,7 @@ export namespace compute_v1 { /** * compute.instances.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.testIamPermissions * @memberOf! () * @@ -34062,7 +34666,7 @@ export namespace compute_v1 { /** * compute.instances.updateAccessConfig - * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateAccessConfig * @memberOf! () * @@ -34141,7 +34745,7 @@ export namespace compute_v1 { /** * compute.instances.updateDisplayDevice - * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateDisplayDevice * @memberOf! () * @@ -34219,7 +34823,7 @@ export namespace compute_v1 { /** * compute.instances.updateNetworkInterface - * @desc Updates an instance's network interface. This method follows PATCH semantics. + * @desc Updates an instance's network interface. This method follows PATCH semantics. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateNetworkInterface * @memberOf! () * @@ -34300,7 +34904,7 @@ export namespace compute_v1 { /** * compute.instances.updateShieldedInstanceConfig - * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.instances.updateShieldedInstanceConfig * @memberOf! () * @@ -35388,7 +35992,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.delete - * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. + * @desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35517,7 +36121,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. + * @desc Returns the specified instance template. Gets a list of available instance templates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35645,7 +36249,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.getIamPolicy * @memberOf! () * @@ -35718,7 +36322,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.insert - * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. + * @desc Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35848,7 +36452,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.list - * @desc Retrieves a list of instance templates that are contained within the specified project. + * @desc Retrieves a list of instance templates that are contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -35991,7 +36595,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.setIamPolicy * @memberOf! () * @@ -36065,7 +36669,7 @@ export namespace compute_v1 { /** * compute.instanceTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.instanceTemplates.testIamPermissions * @memberOf! () * @@ -36296,7 +36900,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.aggregatedList - * @desc Retrieves an aggregated list of interconnect attachments. + * @desc Retrieves an aggregated list of interconnect attachments. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36454,7 +37058,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.delete - * @desc Deletes the specified interconnect attachment. + * @desc Deletes the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36587,7 +37191,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.get - * @desc Returns the specified interconnect attachment. + * @desc Returns the specified interconnect attachment. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36721,7 +37325,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.insert - * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. + * @desc Creates an InterconnectAttachment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -36855,7 +37459,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.list - * @desc Retrieves the list of interconnect attachments contained within the specified region. + * @desc Retrieves the list of interconnect attachments contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37007,7 +37611,7 @@ export namespace compute_v1 { /** * compute.interconnectAttachments.patch - * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnectAttachments.patch * @memberOf! () * @@ -37251,7 +37855,7 @@ export namespace compute_v1 { /** * compute.interconnectLocations.get - * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. + * @desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37381,7 +37985,7 @@ export namespace compute_v1 { /** * compute.interconnectLocations.list - * @desc Retrieves the list of interconnect locations available to the specified project. + * @desc Retrieves the list of interconnect locations available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37576,7 +38180,7 @@ export namespace compute_v1 { /** * compute.interconnects.delete - * @desc Deletes the specified interconnect. + * @desc Deletes the specified interconnect. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37705,7 +38309,7 @@ export namespace compute_v1 { /** * compute.interconnects.get - * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. + * @desc Returns the specified interconnect. Get a list of available interconnects by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -37833,7 +38437,7 @@ export namespace compute_v1 { /** * compute.interconnects.getDiagnostics - * @desc Returns the interconnectDiagnostics for the specified interconnect. + * @desc Returns the interconnectDiagnostics for the specified interconnect. (== suppress_warning http-rest-shadowed ==) * @alias compute.interconnects.getDiagnostics * @memberOf! () * @@ -37919,7 +38523,7 @@ export namespace compute_v1 { /** * compute.interconnects.insert - * @desc Creates a Interconnect in the specified project using the data included in the request. + * @desc Creates a Interconnect in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38048,7 +38652,7 @@ export namespace compute_v1 { /** * compute.interconnects.list - * @desc Retrieves the list of interconnect available to the specified project. + * @desc Retrieves the list of interconnect available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38188,7 +38792,7 @@ export namespace compute_v1 { /** * compute.interconnects.patch - * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38457,7 +39061,7 @@ export namespace compute_v1 { /** * compute.licenseCodes.get - * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. + * @desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenseCodes.get * @memberOf! () * @@ -38531,7 +39135,7 @@ export namespace compute_v1 { /** * compute.licenseCodes.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenseCodes.testIamPermissions * @memberOf! () * @@ -38655,7 +39259,7 @@ export namespace compute_v1 { /** * compute.licenses.delete - * @desc Deletes the specified license. + * @desc Deletes the specified license. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.delete * @memberOf! () * @@ -38730,7 +39334,7 @@ export namespace compute_v1 { /** * compute.licenses.get - * @desc Returns the specified License resource. + * @desc Returns the specified License resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -38855,7 +39459,7 @@ export namespace compute_v1 { /** * compute.licenses.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.getIamPolicy * @memberOf! () * @@ -38928,7 +39532,7 @@ export namespace compute_v1 { /** * compute.licenses.insert - * @desc Create a License resource in the specified project. + * @desc Create a License resource in the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.insert * @memberOf! () * @@ -39002,7 +39606,7 @@ export namespace compute_v1 { /** * compute.licenses.list - * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. + * @desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.list * @memberOf! () * @@ -39080,7 +39684,7 @@ export namespace compute_v1 { /** * compute.licenses.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.setIamPolicy * @memberOf! () * @@ -39154,7 +39758,7 @@ export namespace compute_v1 { /** * compute.licenses.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.licenses.testIamPermissions * @memberOf! () * @@ -39381,7 +39985,7 @@ export namespace compute_v1 { /** * compute.machineTypes.aggregatedList - * @desc Retrieves an aggregated list of machine types. + * @desc Retrieves an aggregated list of machine types. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39528,7 +40132,7 @@ export namespace compute_v1 { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. + * @desc Returns the specified machine type. Gets a list of available machine types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39659,7 +40263,7 @@ export namespace compute_v1 { /** * compute.machineTypes.list - * @desc Retrieves a list of machine types available to the specified project. + * @desc Retrieves a list of machine types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -39891,7 +40495,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by zone. + * @desc Retrieves the list of network endpoint groups and sorts them by zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * @@ -39978,7 +40582,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network endpoint group. + * @desc Attach a list of network endpoints to the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * @@ -40058,7 +40662,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.delete - * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. + * @desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.delete * @memberOf! () * @@ -40135,7 +40739,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network endpoint group. + * @desc Detach a list of network endpoints from the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * @@ -40215,7 +40819,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. + * @desc Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.get * @memberOf! () * @@ -40293,7 +40897,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. + * @desc Creates a network endpoint group in the specified project using the parameters that are included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.insert * @memberOf! () * @@ -40370,7 +40974,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. + * @desc Retrieves the list of network endpoint groups that are located in the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.list * @memberOf! () * @@ -40451,7 +41055,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.listNetworkEndpoints - * @desc Lists the network endpoints in the specified network endpoint group. + * @desc Lists the network endpoints in the specified network endpoint group. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * @@ -40555,7 +41159,7 @@ export namespace compute_v1 { /** * compute.networkEndpointGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.networkEndpointGroups.testIamPermissions * @memberOf! () * @@ -40897,7 +41501,7 @@ export namespace compute_v1 { /** * compute.networks.addPeering - * @desc Adds a peering to the specified network. + * @desc Adds a peering to the specified network. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41031,7 +41635,7 @@ export namespace compute_v1 { /** * compute.networks.delete - * @desc Deletes the specified network. + * @desc Deletes the specified network. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41159,7 +41763,7 @@ export namespace compute_v1 { /** * compute.networks.get - * @desc Returns the specified network. Gets a list of available networks by making a list() request. + * @desc Returns the specified network. Gets a list of available networks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41284,7 +41888,7 @@ export namespace compute_v1 { /** * compute.networks.insert - * @desc Creates a network in the specified project using the data included in the request. + * @desc Creates a network in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41412,7 +42016,7 @@ export namespace compute_v1 { /** * compute.networks.list - * @desc Retrieves the list of networks available to the specified project. + * @desc Retrieves the list of networks available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41551,7 +42155,7 @@ export namespace compute_v1 { /** * compute.networks.patch - * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. + * @desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41685,7 +42289,7 @@ export namespace compute_v1 { /** * compute.networks.removePeering - * @desc Removes a peering from the specified network. + * @desc Removes a peering from the specified network. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41819,7 +42423,7 @@ export namespace compute_v1 { /** * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet mode. + * @desc Switches the network mode from auto subnet mode to custom subnet mode. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -41948,7 +42552,7 @@ export namespace compute_v1 { /** * compute.networks.updatePeering - * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes + * @desc Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes (== suppress_warning http-rest-shadowed ==) * @alias compute.networks.updatePeering * @memberOf! () * @@ -42233,7 +42837,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.addNodes - * @desc Adds specified number of nodes to the node group. + * @desc Adds specified number of nodes to the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.addNodes * @memberOf! () * @@ -42311,7 +42915,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -42392,7 +42996,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.delete - * @desc Deletes the specified NodeGroup resource. + * @desc Deletes the specified NodeGroup resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.delete * @memberOf! () * @@ -42469,7 +43073,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.deleteNodes - * @desc Deletes specified nodes from the node group. + * @desc Deletes specified nodes from the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.deleteNodes * @memberOf! () * @@ -42547,7 +43151,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.get - * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.get * @memberOf! () * @@ -42622,7 +43226,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * @@ -42696,7 +43300,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.insert - * @desc Creates a NodeGroup resource in the specified project using the data included in the request. + * @desc Creates a NodeGroup resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.insert * @memberOf! () * @@ -42773,7 +43377,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.list - * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. + * @desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.list * @memberOf! () * @@ -42850,7 +43454,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.listNodes - * @desc Lists nodes in the node group. + * @desc Lists nodes in the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.listNodes * @memberOf! () * @@ -42930,7 +43534,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * @@ -43005,7 +43609,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.setNodeTemplate - * @desc Updates the node template of the node group. + * @desc Updates the node template of the node group. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.setNodeTemplate * @memberOf! () * @@ -43083,7 +43687,7 @@ export namespace compute_v1 { /** * compute.nodeGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeGroups.testIamPermissions * @memberOf! () * @@ -43496,7 +44100,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.aggregatedList - * @desc Retrieves an aggregated list of node templates. + * @desc Retrieves an aggregated list of node templates. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.aggregatedList * @memberOf! () * @@ -43581,7 +44185,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.delete - * @desc Deletes the specified NodeTemplate resource. + * @desc Deletes the specified NodeTemplate resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.delete * @memberOf! () * @@ -43658,7 +44262,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.get - * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. + * @desc Returns the specified node template. Gets a list of available node templates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.get * @memberOf! () * @@ -43734,7 +44338,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.getIamPolicy * @memberOf! () * @@ -43808,7 +44412,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.insert - * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. + * @desc Creates a NodeTemplate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.insert * @memberOf! () * @@ -43885,7 +44489,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.list - * @desc Retrieves a list of node templates available to the specified project. + * @desc Retrieves a list of node templates available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.list * @memberOf! () * @@ -43964,7 +44568,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.setIamPolicy * @memberOf! () * @@ -44039,7 +44643,7 @@ export namespace compute_v1 { /** * compute.nodeTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTemplates.testIamPermissions * @memberOf! () * @@ -44327,7 +44931,7 @@ export namespace compute_v1 { /** * compute.nodeTypes.aggregatedList - * @desc Retrieves an aggregated list of node types. + * @desc Retrieves an aggregated list of node types. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.aggregatedList * @memberOf! () * @@ -44408,7 +45012,7 @@ export namespace compute_v1 { /** * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node types by making a list() request. + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.get * @memberOf! () * @@ -44481,7 +45085,7 @@ export namespace compute_v1 { /** * compute.nodeTypes.list - * @desc Retrieves a list of node types available to the specified project. + * @desc Retrieves a list of node types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.nodeTypes.list * @memberOf! () * @@ -44644,7 +45248,7 @@ export namespace compute_v1 { /** * compute.projects.disableXpnHost - * @desc Disable this project as a shared VPC host project. + * @desc Disable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -44768,7 +45372,7 @@ export namespace compute_v1 { /** * compute.projects.disableXpnResource - * @desc Disable a service resource (also known as service project) associated with this host project. + * @desc Disable a service resource (also known as service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -44897,7 +45501,7 @@ export namespace compute_v1 { /** * compute.projects.enableXpnHost - * @desc Enable this project as a shared VPC host project. + * @desc Enable this project as a shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45021,7 +45625,7 @@ export namespace compute_v1 { /** * compute.projects.enableXpnResource - * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. + * @desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45150,7 +45754,7 @@ export namespace compute_v1 { /** * compute.projects.get - * @desc Returns the specified Project resource. + * @desc Returns the specified Project resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45271,7 +45875,7 @@ export namespace compute_v1 { /** * compute.projects.getXpnHost - * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. + * @desc Gets the shared VPC host project that this project links to. May be empty if no link exists. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45392,7 +45996,7 @@ export namespace compute_v1 { /** * compute.projects.getXpnResources - * @desc Gets service resources (a.k.a service project) associated with this host project. + * @desc Gets service resources (a.k.a service project) associated with this host project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45536,7 +46140,7 @@ export namespace compute_v1 { /** * compute.projects.listXpnHosts - * @desc Lists all shared VPC host projects visible to the user in an organization. + * @desc Lists all shared VPC host projects visible to the user in an organization. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45681,7 +46285,7 @@ export namespace compute_v1 { /** * compute.projects.moveDisk - * @desc Moves a persistent disk from one zone to another. + * @desc Moves a persistent disk from one zone to another. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45811,7 +46415,7 @@ export namespace compute_v1 { /** * compute.projects.moveInstance - * @desc Moves an instance and its attached persistent disks from one zone to another. + * @desc Moves an instance and its attached persistent disks from one zone to another. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -45940,7 +46544,7 @@ export namespace compute_v1 { /** * compute.projects.setCommonInstanceMetadata - * @desc Sets metadata common to all instances within the specified project using the data included in the request. + * @desc Sets metadata common to all instances within the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -46072,7 +46676,7 @@ export namespace compute_v1 { /** * compute.projects.setDefaultNetworkTier - * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. + * @desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. (== suppress_warning http-rest-shadowed ==) * @alias compute.projects.setDefaultNetworkTier * @memberOf! () * @@ -46149,7 +46753,7 @@ export namespace compute_v1 { /** * compute.projects.setUsageExportBucket - * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. + * @desc Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -46551,7 +47155,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.delete - * @desc Deletes the specified autoscaler. + * @desc Deletes the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -46684,7 +47288,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.get - * @desc Returns the specified autoscaler. + * @desc Returns the specified autoscaler. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -46816,7 +47420,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.insert - * @desc Creates an autoscaler in the specified project using the data included in the request. + * @desc Creates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -46950,7 +47554,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.list - * @desc Retrieves a list of autoscalers contained within the specified region. + * @desc Retrieves a list of autoscalers contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47097,7 +47701,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.patch - * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47233,7 +47837,7 @@ export namespace compute_v1 { /** * compute.regionAutoscalers.update - * @desc Updates an autoscaler in the specified project using the data included in the request. + * @desc Updates an autoscaler in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47536,7 +48140,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.delete - * @desc Deletes the specified regional BackendService resource. + * @desc Deletes the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47669,7 +48273,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.get - * @desc Returns the specified regional BackendService resource. + * @desc Returns the specified regional BackendService resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47801,7 +48405,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.getHealth - * @desc Gets the most recent health check results for this regional BackendService. + * @desc Gets the most recent health check results for this regional BackendService. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -47944,7 +48548,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.insert - * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. + * @desc Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48078,7 +48682,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.list - * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. + * @desc Retrieves the list of regional BackendService resources available to the specified project in the given region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48223,7 +48827,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.patch - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48362,7 +48966,7 @@ export namespace compute_v1 { /** * compute.regionBackendServices.update - * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. + * @desc Updates the specified regional BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48693,7 +49297,7 @@ export namespace compute_v1 { /** * compute.regionCommitments.aggregatedList - * @desc Retrieves an aggregated list of commitments. + * @desc Retrieves an aggregated list of commitments. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48837,7 +49441,7 @@ export namespace compute_v1 { /** * compute.regionCommitments.get - * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. + * @desc Returns the specified commitment resource. Gets a list of available commitments by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -48969,7 +49573,7 @@ export namespace compute_v1 { /** * compute.regionCommitments.insert - * @desc Creates a commitment in the specified project using the data included in the request. + * @desc Creates a commitment in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -49103,7 +49707,7 @@ export namespace compute_v1 { /** * compute.regionCommitments.list - * @desc Retrieves a list of commitments contained within the specified region. + * @desc Retrieves a list of commitments contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -49361,7 +49965,7 @@ export namespace compute_v1 { /** * compute.regionDisks.addResourcePolicies - * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. + * @desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.addResourcePolicies * @memberOf! () * @@ -49439,7 +50043,7 @@ export namespace compute_v1 { /** * compute.regionDisks.createSnapshot - * @desc Creates a snapshot of this regional disk. + * @desc Creates a snapshot of this regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.createSnapshot * @memberOf! () * @@ -49517,7 +50121,7 @@ export namespace compute_v1 { /** * compute.regionDisks.delete - * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. + * @desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.delete * @memberOf! () * @@ -49594,7 +50198,7 @@ export namespace compute_v1 { /** * compute.regionDisks.get - * @desc Returns a specified regional persistent disk. + * @desc Returns a specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.get * @memberOf! () * @@ -49667,7 +50271,7 @@ export namespace compute_v1 { /** * compute.regionDisks.insert - * @desc Creates a persistent regional disk in the specified project using the data included in the request. + * @desc Creates a persistent regional disk in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.insert * @memberOf! () * @@ -49744,7 +50348,7 @@ export namespace compute_v1 { /** * compute.regionDisks.list - * @desc Retrieves the list of persistent disks contained within the specified region. + * @desc Retrieves the list of persistent disks contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.list * @memberOf! () * @@ -49819,7 +50423,7 @@ export namespace compute_v1 { /** * compute.regionDisks.removeResourcePolicies - * @desc Removes resource policies from a regional disk. + * @desc Removes resource policies from a regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.removeResourcePolicies * @memberOf! () * @@ -49899,7 +50503,7 @@ export namespace compute_v1 { /** * compute.regionDisks.resize - * @desc Resizes the specified regional persistent disk. + * @desc Resizes the specified regional persistent disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.resize * @memberOf! () * @@ -49977,7 +50581,7 @@ export namespace compute_v1 { /** * compute.regionDisks.setLabels - * @desc Sets the labels on the target regional disk. + * @desc Sets the labels on the target regional disk. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.setLabels * @memberOf! () * @@ -50055,7 +50659,7 @@ export namespace compute_v1 { /** * compute.regionDisks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDisks.testIamPermissions * @memberOf! () * @@ -50417,7 +51021,7 @@ export namespace compute_v1 { /** * compute.regionDiskTypes.get - * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. + * @desc Returns the specified regional disk type. Gets a list of available disk types by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDiskTypes.get * @memberOf! () * @@ -50491,7 +51095,7 @@ export namespace compute_v1 { /** * compute.regionDiskTypes.list - * @desc Retrieves a list of regional disk types available to the specified project. + * @desc Retrieves a list of regional disk types available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionDiskTypes.list * @memberOf! () * @@ -50630,7 +51234,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.delete - * @desc Deletes the specified HealthCheck resource. + * @desc Deletes the specified HealthCheck resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.delete * @memberOf! () * @@ -50707,7 +51311,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.get - * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. + * @desc Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.get * @memberOf! () * @@ -50783,7 +51387,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.insert - * @desc Creates a HealthCheck resource in the specified project using the data included in the request. + * @desc Creates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.insert * @memberOf! () * @@ -50860,7 +51464,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.list - * @desc Retrieves the list of HealthCheck resources available to the specified project. + * @desc Retrieves the list of HealthCheck resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.list * @memberOf! () * @@ -50939,7 +51543,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.patch - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.patch * @memberOf! () * @@ -51017,7 +51621,7 @@ export namespace compute_v1 { /** * compute.regionHealthChecks.update - * @desc Updates a HealthCheck resource in the specified project using the data included in the request. + * @desc Updates a HealthCheck resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionHealthChecks.update * @memberOf! () * @@ -51262,7 +51866,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.abandonInstances - * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51400,7 +52004,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. + * @desc Deletes the specified managed instance group and all of the instances in that group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51533,7 +52137,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51671,7 +52275,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. + * @desc Returns all of the details about the specified managed instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51805,7 +52409,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.insert - * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. + * @desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -51939,7 +52543,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.list - * @desc Retrieves the list of managed instance groups that are contained within the specified region. + * @desc Retrieves the list of managed instance groups that are contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52093,7 +52697,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.listManagedInstances - * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. + * @desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52253,7 +52857,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.patch - * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionInstanceGroupManagers.patch * @memberOf! () * @@ -52331,7 +52935,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.recreateInstances - * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @desc Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52469,7 +53073,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.resize - * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * @desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52606,7 +53210,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.setInstanceTemplate - * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. + * @desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -52744,7 +53348,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroupManagers.setTargetPools - * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. + * @desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53229,7 +53833,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.get - * @desc Returns the specified instance group resource. + * @desc Returns the specified instance group resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53361,7 +53965,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.list - * @desc Retrieves the list of instance group resources contained within the specified region. + * @desc Retrieves the list of instance group resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53508,7 +54112,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.listInstances - * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. + * @desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53671,7 +54275,7 @@ export namespace compute_v1 { /** * compute.regionInstanceGroups.setNamedPorts - * @desc Sets the named ports for the specified regional instance group. + * @desc Sets the named ports for the specified regional instance group. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -53939,7 +54543,7 @@ export namespace compute_v1 { /** * compute.regionOperations.delete - * @desc Deletes the specified region-specific Operations resource. + * @desc Deletes the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54066,7 +54670,7 @@ export namespace compute_v1 { /** * compute.regionOperations.get - * @desc Retrieves the specified region-specific Operations resource. + * @desc Retrieves the specified region-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54198,7 +54802,7 @@ export namespace compute_v1 { /** * compute.regionOperations.list - * @desc Retrieves a list of Operation resources contained within the specified region. + * @desc Retrieves a list of Operation resources contained within the specified region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54423,7 +55027,7 @@ export namespace compute_v1 { /** * compute.regions.get - * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. + * @desc Returns the specified Region resource. Gets a list of available regions by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54547,7 +55151,7 @@ export namespace compute_v1 { /** * compute.regions.list - * @desc Retrieves the list of region resources available to the specified project. + * @desc Retrieves the list of region resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -54737,7 +55341,7 @@ export namespace compute_v1 { /** * compute.regionSslCertificates.delete - * @desc Deletes the specified SslCertificate resource in the region. + * @desc Deletes the specified SslCertificate resource in the region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.delete * @memberOf! () * @@ -54814,7 +55418,7 @@ export namespace compute_v1 { /** * compute.regionSslCertificates.get - * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.get * @memberOf! () * @@ -54890,7 +55494,7 @@ export namespace compute_v1 { /** * compute.regionSslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request + * @desc Creates a SslCertificate resource in the specified project and region using the data included in the request (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.insert * @memberOf! () * @@ -54967,7 +55571,7 @@ export namespace compute_v1 { /** * compute.regionSslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. + * @desc Retrieves the list of SslCertificate resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionSslCertificates.list * @memberOf! () * @@ -55155,7 +55759,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. + * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.delete * @memberOf! () * @@ -55232,7 +55836,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.get * @memberOf! () * @@ -55308,7 +55912,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.insert * @memberOf! () * @@ -55385,7 +55989,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.list * @memberOf! () * @@ -55464,7 +56068,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. + * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpProxies.setUrlMap * @memberOf! () * @@ -55680,7 +56284,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. + * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.delete * @memberOf! () * @@ -55757,7 +56361,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.get * @memberOf! () * @@ -55833,7 +56437,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.insert * @memberOf! () * @@ -55910,7 +56514,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.list * @memberOf! () * @@ -55991,7 +56595,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. + * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.setSslCertificates * @memberOf! () * @@ -56069,7 +56673,7 @@ export namespace compute_v1 { /** * compute.regionTargetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. + * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionTargetHttpsProxies.setUrlMap * @memberOf! () * @@ -56314,7 +56918,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.delete - * @desc Deletes the specified UrlMap resource. + * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.delete * @memberOf! () * @@ -56391,7 +56995,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.get * @memberOf! () * @@ -56465,7 +57069,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.insert * @memberOf! () * @@ -56542,7 +57146,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. + * @desc Retrieves the list of UrlMap resources available to the specified project in the specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.list * @memberOf! () * @@ -56621,7 +57225,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.patch * @memberOf! () * @@ -56699,7 +57303,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. + * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.update * @memberOf! () * @@ -56777,7 +57381,7 @@ export namespace compute_v1 { /** * compute.regionUrlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) * @alias compute.regionUrlMaps.validate * @memberOf! () * @@ -57050,7 +57654,7 @@ export namespace compute_v1 { /** * compute.reservations.aggregatedList - * @desc Retrieves an aggregated list of reservations. + * @desc Retrieves an aggregated list of reservations. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.aggregatedList * @memberOf! () * @@ -57134,7 +57738,7 @@ export namespace compute_v1 { /** * compute.reservations.delete - * @desc Deletes the specified reservation. + * @desc Deletes the specified reservation. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.delete * @memberOf! () * @@ -57211,7 +57815,7 @@ export namespace compute_v1 { /** * compute.reservations.get - * @desc Retrieves information about the specified reservation. + * @desc Retrieves information about the specified reservation. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.get * @memberOf! () * @@ -57286,7 +57890,7 @@ export namespace compute_v1 { /** * compute.reservations.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.getIamPolicy * @memberOf! () * @@ -57360,7 +57964,7 @@ export namespace compute_v1 { /** * compute.reservations.insert - * @desc Creates a new reservation. For more information, read Reserving zonal resources. + * @desc Creates a new reservation. For more information, read Reserving zonal resources. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.insert * @memberOf! () * @@ -57437,7 +58041,7 @@ export namespace compute_v1 { /** * compute.reservations.list - * @desc A list of all the reservations that have been configured for the specified project in specified zone. + * @desc A list of all the reservations that have been configured for the specified project in specified zone. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.list * @memberOf! () * @@ -57516,7 +58120,7 @@ export namespace compute_v1 { /** * compute.reservations.resize - * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. + * @desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.resize * @memberOf! () * @@ -57594,7 +58198,7 @@ export namespace compute_v1 { /** * compute.reservations.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.setIamPolicy * @memberOf! () * @@ -57669,7 +58273,7 @@ export namespace compute_v1 { /** * compute.reservations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.reservations.testIamPermissions * @memberOf! () * @@ -57985,7 +58589,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.aggregatedList - * @desc Retrieves an aggregated list of resource policies. + * @desc Retrieves an aggregated list of resource policies. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.aggregatedList * @memberOf! () * @@ -58072,7 +58676,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.delete - * @desc Deletes the specified resource policy. + * @desc Deletes the specified resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.delete * @memberOf! () * @@ -58149,7 +58753,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.get - * @desc Retrieves all information of the specified resource policy. + * @desc Retrieves all information of the specified resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.get * @memberOf! () * @@ -58225,7 +58829,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.getIamPolicy * @memberOf! () * @@ -58299,7 +58903,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.insert - * @desc Creates a new resource policy. + * @desc Creates a new resource policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.insert * @memberOf! () * @@ -58376,7 +58980,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.list - * @desc A list all the resource policies that have been configured for the specified project in specified region. + * @desc A list all the resource policies that have been configured for the specified project in specified region. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.list * @memberOf! () * @@ -58455,7 +59059,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.setIamPolicy * @memberOf! () * @@ -58530,7 +59134,7 @@ export namespace compute_v1 { /** * compute.resourcePolicies.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.resourcePolicies.testIamPermissions * @memberOf! () * @@ -58818,7 +59422,7 @@ export namespace compute_v1 { /** * compute.routers.aggregatedList - * @desc Retrieves an aggregated list of routers. + * @desc Retrieves an aggregated list of routers. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -58962,7 +59566,7 @@ export namespace compute_v1 { /** * compute.routers.delete - * @desc Deletes the specified Router resource. + * @desc Deletes the specified Router resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59094,7 +59698,7 @@ export namespace compute_v1 { /** * compute.routers.get - * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. + * @desc Returns the specified Router resource. Gets a list of available routers by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59223,7 +59827,7 @@ export namespace compute_v1 { /** * compute.routers.getNatMappingInfo - * @desc Retrieves runtime Nat mapping information of VM endpoints. + * @desc Retrieves runtime Nat mapping information of VM endpoints. (== suppress_warning http-rest-shadowed ==) * @alias compute.routers.getNatMappingInfo * @memberOf! () * @@ -59310,7 +59914,7 @@ export namespace compute_v1 { /** * compute.routers.getRouterStatus - * @desc Retrieves runtime information of the specified router. + * @desc Retrieves runtime information of the specified router. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59446,7 +60050,7 @@ export namespace compute_v1 { /** * compute.routers.insert - * @desc Creates a Router resource in the specified project and region using the data included in the request. + * @desc Creates a Router resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59579,7 +60183,7 @@ export namespace compute_v1 { /** * compute.routers.list - * @desc Retrieves a list of Router resources available to the specified project. + * @desc Retrieves a list of Router resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59723,7 +60327,7 @@ export namespace compute_v1 { /** * compute.routers.patch - * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -59861,7 +60465,7 @@ export namespace compute_v1 { /** * compute.routers.preview - * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. + * @desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60001,7 +60605,7 @@ export namespace compute_v1 { /** * compute.routers.update - * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. + * @desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60408,7 +61012,7 @@ export namespace compute_v1 { /** * compute.routes.delete - * @desc Deletes the specified Route resource. + * @desc Deletes the specified Route resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60535,7 +61139,7 @@ export namespace compute_v1 { /** * compute.routes.get - * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. + * @desc Returns the specified Route resource. Gets a list of available routes by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60659,7 +61263,7 @@ export namespace compute_v1 { /** * compute.routes.insert - * @desc Creates a Route resource in the specified project using the data included in the request. + * @desc Creates a Route resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -60787,7 +61391,7 @@ export namespace compute_v1 { /** * compute.routes.list - * @desc Retrieves the list of Route resources available to the specified project. + * @desc Retrieves the list of Route resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -61015,7 +61619,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.addRule - * @desc Inserts a rule into a security policy. + * @desc Inserts a rule into a security policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.addRule * @memberOf! () * @@ -61091,7 +61695,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.delete - * @desc Deletes the specified policy. + * @desc Deletes the specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.delete * @memberOf! () * @@ -61167,7 +61771,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.get - * @desc List all of the ordered rules present in a single specified policy. + * @desc List all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.get * @memberOf! () * @@ -61242,7 +61846,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.getRule - * @desc Gets a rule at the specified priority. + * @desc Gets a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.getRule * @memberOf! () * @@ -61318,7 +61922,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.insert - * @desc Creates a new policy in the specified project using the data included in the request. + * @desc Creates a new policy in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.insert * @memberOf! () * @@ -61393,7 +61997,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.list - * @desc List all the policies that have been configured for the specified project. + * @desc List all the policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.list * @memberOf! () * @@ -61470,7 +62074,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.patch - * @desc Patches the specified policy with the data included in the request. + * @desc Patches the specified policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.patch * @memberOf! () * @@ -61547,7 +62151,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.patchRule - * @desc Patches a rule at the specified priority. + * @desc Patches a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.patchRule * @memberOf! () * @@ -61624,7 +62228,7 @@ export namespace compute_v1 { /** * compute.securityPolicies.removeRule - * @desc Deletes a rule at the specified priority. + * @desc Deletes a rule at the specified priority. (== suppress_warning http-rest-shadowed ==) * @alias compute.securityPolicies.removeRule * @memberOf! () * @@ -61904,7 +62508,7 @@ export namespace compute_v1 { /** * compute.snapshots.delete - * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. + * @desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62032,7 +62636,7 @@ export namespace compute_v1 { /** * compute.snapshots.get - * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. + * @desc Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62157,7 +62761,7 @@ export namespace compute_v1 { /** * compute.snapshots.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.getIamPolicy * @memberOf! () * @@ -62230,7 +62834,7 @@ export namespace compute_v1 { /** * compute.snapshots.list - * @desc Retrieves the list of Snapshot resources contained within the specified project. + * @desc Retrieves the list of Snapshot resources contained within the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62369,7 +62973,7 @@ export namespace compute_v1 { /** * compute.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.setIamPolicy * @memberOf! () * @@ -62443,7 +63047,7 @@ export namespace compute_v1 { /** * compute.snapshots.setLabels - * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -62576,7 +63180,7 @@ export namespace compute_v1 { /** * compute.snapshots.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.snapshots.testIamPermissions * @memberOf! () * @@ -62804,7 +63408,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.aggregatedList - * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. + * @desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslCertificates.aggregatedList * @memberOf! () * @@ -62891,7 +63495,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.delete - * @desc Deletes the specified SslCertificate resource. + * @desc Deletes the specified SslCertificate resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -63020,7 +63624,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.get - * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. + * @desc Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -63148,7 +63752,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.insert - * @desc Creates a SslCertificate resource in the specified project using the data included in the request. + * @desc Creates a SslCertificate resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -63277,7 +63881,7 @@ export namespace compute_v1 { /** * compute.sslCertificates.list - * @desc Retrieves the list of SslCertificate resources available to the specified project. + * @desc Retrieves the list of SslCertificate resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -63538,7 +64142,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.delete - * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. + * @desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.delete * @memberOf! () * @@ -63614,7 +64218,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.get - * @desc Lists all of the ordered rules present in a single specified policy. + * @desc Lists all of the ordered rules present in a single specified policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.get * @memberOf! () * @@ -63688,7 +64292,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.insert - * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. + * @desc Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.insert * @memberOf! () * @@ -63763,7 +64367,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.list - * @desc Lists all the SSL policies that have been configured for the specified project. + * @desc Lists all the SSL policies that have been configured for the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.list * @memberOf! () * @@ -63839,7 +64443,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.listAvailableFeatures - * @desc Lists all features that can be specified in the SSL policy when using custom profile. + * @desc Lists all features that can be specified in the SSL policy when using custom profile. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.listAvailableFeatures * @memberOf! () * @@ -63934,7 +64538,7 @@ export namespace compute_v1 { /** * compute.sslPolicies.patch - * @desc Patches the specified SSL policy with the data included in the request. + * @desc Patches the specified SSL policy with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.sslPolicies.patch * @memberOf! () * @@ -64155,7 +64759,7 @@ export namespace compute_v1 { /** * compute.subnetworks.aggregatedList - * @desc Retrieves an aggregated list of subnetworks. + * @desc Retrieves an aggregated list of subnetworks. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -64299,7 +64903,7 @@ export namespace compute_v1 { /** * compute.subnetworks.delete - * @desc Deletes the specified subnetwork. + * @desc Deletes the specified subnetwork. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -64432,7 +65036,7 @@ export namespace compute_v1 { /** * compute.subnetworks.expandIpCidrRange - * @desc Expands the IP CIDR range of the subnetwork to a specified value. + * @desc Expands the IP CIDR range of the subnetwork to a specified value. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -64570,7 +65174,7 @@ export namespace compute_v1 { /** * compute.subnetworks.get - * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. + * @desc Returns the specified subnetwork. Gets a list of available subnetworks list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -64701,7 +65305,7 @@ export namespace compute_v1 { /** * compute.subnetworks.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * @desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.getIamPolicy * @memberOf! () * @@ -64775,7 +65379,7 @@ export namespace compute_v1 { /** * compute.subnetworks.insert - * @desc Creates a subnetwork in the specified project using the data included in the request. + * @desc Creates a subnetwork in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -64909,7 +65513,7 @@ export namespace compute_v1 { /** * compute.subnetworks.list - * @desc Retrieves a list of subnetworks available to the specified project. + * @desc Retrieves a list of subnetworks available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -65053,7 +65657,7 @@ export namespace compute_v1 { /** * compute.subnetworks.listUsable - * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. + * @desc Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.listUsable * @memberOf! () * @@ -65140,11 +65744,12 @@ export namespace compute_v1 { /** * compute.subnetworks.patch - * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. + * @desc Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingeprint of the subnetwork resource being patched. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.patch * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.drainTimeoutSeconds The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). @@ -65218,7 +65823,7 @@ export namespace compute_v1 { /** * compute.subnetworks.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.setIamPolicy * @memberOf! () * @@ -65293,7 +65898,7 @@ export namespace compute_v1 { /** * compute.subnetworks.setPrivateIpGoogleAccess - * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. + * @desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -65433,7 +66038,7 @@ export namespace compute_v1 { /** * compute.subnetworks.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.subnetworks.testIamPermissions * @memberOf! () * @@ -65724,6 +66329,10 @@ export namespace compute_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped. + */ + drainTimeoutSeconds?: number; /** * Project ID for this request. */ @@ -65834,7 +66443,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. + * @desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpProxies.aggregatedList * @memberOf! () * @@ -65921,7 +66530,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. + * @desc Deletes the specified TargetHttpProxy resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -66050,7 +66659,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. + * @desc Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -66178,7 +66787,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetHttpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -66308,7 +66917,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. + * @desc Retrieves the list of TargetHttpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -66449,7 +67058,7 @@ export namespace compute_v1 { /** * compute.targetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. + * @desc Changes the URL map for TargetHttpProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -66729,7 +67338,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.aggregatedList - * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. + * @desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.aggregatedList * @memberOf! () * @@ -66816,7 +67425,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.delete - * @desc Deletes the specified TargetHttpsProxy resource. + * @desc Deletes the specified TargetHttpsProxy resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -66945,7 +67554,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.get - * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. + * @desc Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67073,7 +67682,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.insert - * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67203,7 +67812,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.list - * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. + * @desc Retrieves the list of TargetHttpsProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67346,7 +67955,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setQuicOverride - * @desc Sets the QUIC override policy for TargetHttpsProxy. + * @desc Sets the QUIC override policy for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.setQuicOverride * @memberOf! () * @@ -67423,7 +68032,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setSslCertificates - * @desc Replaces SslCertificates for TargetHttpsProxy. + * @desc Replaces SslCertificates for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67557,7 +68166,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setSslPolicy - * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetHttpsProxies.setSslPolicy * @memberOf! () * @@ -67634,7 +68243,7 @@ export namespace compute_v1 { /** * compute.targetHttpsProxies.setUrlMap - * @desc Changes the URL map for TargetHttpsProxy. + * @desc Changes the URL map for TargetHttpsProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -67989,7 +68598,7 @@ export namespace compute_v1 { /** * compute.targetInstances.aggregatedList - * @desc Retrieves an aggregated list of target instances. + * @desc Retrieves an aggregated list of target instances. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68139,7 +68748,7 @@ export namespace compute_v1 { /** * compute.targetInstances.delete - * @desc Deletes the specified TargetInstance resource. + * @desc Deletes the specified TargetInstance resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68272,7 +68881,7 @@ export namespace compute_v1 { /** * compute.targetInstances.get - * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. + * @desc Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68404,7 +69013,7 @@ export namespace compute_v1 { /** * compute.targetInstances.insert - * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. + * @desc Creates a TargetInstance resource in the specified project and zone using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68538,7 +69147,7 @@ export namespace compute_v1 { /** * compute.targetInstances.list - * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. + * @desc Retrieves a list of TargetInstance resources available to the specified project and zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68820,7 +69429,7 @@ export namespace compute_v1 { /** * compute.targetPools.addHealthCheck - * @desc Adds health check URLs to a target pool. + * @desc Adds health check URLs to a target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -68958,7 +69567,7 @@ export namespace compute_v1 { /** * compute.targetPools.addInstance - * @desc Adds an instance to a target pool. + * @desc Adds an instance to a target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69096,7 +69705,7 @@ export namespace compute_v1 { /** * compute.targetPools.aggregatedList - * @desc Retrieves an aggregated list of target pools. + * @desc Retrieves an aggregated list of target pools. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69240,7 +69849,7 @@ export namespace compute_v1 { /** * compute.targetPools.delete - * @desc Deletes the specified target pool. + * @desc Deletes the specified target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69373,7 +69982,7 @@ export namespace compute_v1 { /** * compute.targetPools.get - * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. + * @desc Returns the specified target pool. Gets a list of available target pools by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69504,7 +70113,7 @@ export namespace compute_v1 { /** * compute.targetPools.getHealth - * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. + * @desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69645,7 +70254,7 @@ export namespace compute_v1 { /** * compute.targetPools.insert - * @desc Creates a target pool in the specified project and region using the data included in the request. + * @desc Creates a target pool in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69779,7 +70388,7 @@ export namespace compute_v1 { /** * compute.targetPools.list - * @desc Retrieves a list of target pools available to the specified project and region. + * @desc Retrieves a list of target pools available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -69923,7 +70532,7 @@ export namespace compute_v1 { /** * compute.targetPools.removeHealthCheck - * @desc Removes health check URL from a target pool. + * @desc Removes health check URL from a target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -70061,7 +70670,7 @@ export namespace compute_v1 { /** * compute.targetPools.removeInstance - * @desc Removes instance URL from a target pool. + * @desc Removes instance URL from a target pool. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -70199,7 +70808,7 @@ export namespace compute_v1 { /** * compute.targetPools.setBackup - * @desc Changes a backup target pool's configurations. + * @desc Changes a backup target pool's configurations. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -70647,7 +71256,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.delete - * @desc Deletes the specified TargetSslProxy resource. + * @desc Deletes the specified TargetSslProxy resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -70776,7 +71385,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.get - * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. + * @desc Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -70904,7 +71513,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.insert - * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetSslProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71033,7 +71642,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.list - * @desc Retrieves the list of TargetSslProxy resources available to the specified project. + * @desc Retrieves the list of TargetSslProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71173,7 +71782,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setBackendService - * @desc Changes the BackendService for TargetSslProxy. + * @desc Changes the BackendService for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71307,7 +71916,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetSslProxy. + * @desc Changes the ProxyHeaderType for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71441,7 +72050,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setSslCertificates - * @desc Changes SslCertificates for TargetSslProxy. + * @desc Changes SslCertificates for TargetSslProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71575,7 +72184,7 @@ export namespace compute_v1 { /** * compute.targetSslProxies.setSslPolicy - * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. + * @desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. (== suppress_warning http-rest-shadowed ==) * @alias compute.targetSslProxies.setSslPolicy * @memberOf! () * @@ -71845,7 +72454,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.delete - * @desc Deletes the specified TargetTcpProxy resource. + * @desc Deletes the specified TargetTcpProxy resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -71974,7 +72583,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.get - * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. + * @desc Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72102,7 +72711,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.insert - * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. + * @desc Creates a TargetTcpProxy resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72231,7 +72840,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.list - * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. + * @desc Retrieves the list of TargetTcpProxy resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72371,7 +72980,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.setBackendService - * @desc Changes the BackendService for TargetTcpProxy. + * @desc Changes the BackendService for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72505,7 +73114,7 @@ export namespace compute_v1 { /** * compute.targetTcpProxies.setProxyHeader - * @desc Changes the ProxyHeaderType for TargetTcpProxy. + * @desc Changes the ProxyHeaderType for TargetTcpProxy. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72782,7 +73391,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.aggregatedList - * @desc Retrieves an aggregated list of target VPN gateways. + * @desc Retrieves an aggregated list of target VPN gateways. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -72932,7 +73541,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.delete - * @desc Deletes the specified target VPN gateway. + * @desc Deletes the specified target VPN gateway. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -73065,7 +73674,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.get - * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. + * @desc Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -73197,7 +73806,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.insert - * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. + * @desc Creates a target VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -73331,7 +73940,7 @@ export namespace compute_v1 { /** * compute.targetVpnGateways.list - * @desc Retrieves a list of target VPN gateways available to the specified project and region. + * @desc Retrieves a list of target VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -73615,7 +74224,7 @@ export namespace compute_v1 { /** * compute.urlMaps.aggregatedList - * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. + * @desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project. (== suppress_warning http-rest-shadowed ==) * @alias compute.urlMaps.aggregatedList * @memberOf! () * @@ -73696,7 +74305,7 @@ export namespace compute_v1 { /** * compute.urlMaps.delete - * @desc Deletes the specified UrlMap resource. + * @desc Deletes the specified UrlMap resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -73823,7 +74432,7 @@ export namespace compute_v1 { /** * compute.urlMaps.get - * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. + * @desc Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -73947,7 +74556,7 @@ export namespace compute_v1 { /** * compute.urlMaps.insert - * @desc Creates a UrlMap resource in the specified project using the data included in the request. + * @desc Creates a UrlMap resource in the specified project using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74075,7 +74684,7 @@ export namespace compute_v1 { /** * compute.urlMaps.invalidateCache - * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. + * @desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74209,7 +74818,7 @@ export namespace compute_v1 { /** * compute.urlMaps.list - * @desc Retrieves the list of UrlMap resources available to the specified project. + * @desc Retrieves the list of UrlMap resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74348,7 +74957,7 @@ export namespace compute_v1 { /** * compute.urlMaps.patch - * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74481,7 +75090,7 @@ export namespace compute_v1 { /** * compute.urlMaps.update - * @desc Updates the specified UrlMap resource with the data included in the request. + * @desc Updates the specified UrlMap resource with the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74614,7 +75223,7 @@ export namespace compute_v1 { /** * compute.urlMaps.validate - * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. + * @desc Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -74960,7 +75569,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.aggregatedList - * @desc Retrieves an aggregated list of VPN gateways. + * @desc Retrieves an aggregated list of VPN gateways. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.aggregatedList * @memberOf! () * @@ -75041,7 +75650,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.delete - * @desc Deletes the specified VPN gateway. + * @desc Deletes the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.delete * @memberOf! () * @@ -75118,7 +75727,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.get - * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. + * @desc Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.get * @memberOf! () * @@ -75193,7 +75802,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.getStatus - * @desc Returns the status for the specified VPN gateway. + * @desc Returns the status for the specified VPN gateway. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.getStatus * @memberOf! () * @@ -75278,7 +75887,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.insert - * @desc Creates a VPN gateway in the specified project and region using the data included in the request. + * @desc Creates a VPN gateway in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.insert * @memberOf! () * @@ -75355,7 +75964,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.list - * @desc Retrieves a list of VPN gateways available to the specified project and region. + * @desc Retrieves a list of VPN gateways available to the specified project and region. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.list * @memberOf! () * @@ -75433,7 +76042,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.setLabels - * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. + * @desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.setLabels * @memberOf! () * @@ -75511,7 +76120,7 @@ export namespace compute_v1 { /** * compute.vpnGateways.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. + * @desc Returns permissions that a caller has on the specified resource. (== suppress_warning http-rest-shadowed ==) * @alias compute.vpnGateways.testIamPermissions * @memberOf! () * @@ -75801,7 +76410,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.aggregatedList - * @desc Retrieves an aggregated list of VPN tunnels. + * @desc Retrieves an aggregated list of VPN tunnels. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -75945,7 +76554,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.delete - * @desc Deletes the specified VpnTunnel resource. + * @desc Deletes the specified VpnTunnel resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76078,7 +76687,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.get - * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. + * @desc Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76209,7 +76818,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.insert - * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. + * @desc Creates a VpnTunnel resource in the specified project and region using the data included in the request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76343,7 +76952,7 @@ export namespace compute_v1 { /** * compute.vpnTunnels.list - * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. + * @desc Retrieves a list of VpnTunnel resources contained in the specified project and region. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76622,7 +77231,7 @@ export namespace compute_v1 { /** * compute.zoneOperations.delete - * @desc Deletes the specified zone-specific Operations resource. + * @desc Deletes the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76749,7 +77358,7 @@ export namespace compute_v1 { /** * compute.zoneOperations.get - * @desc Retrieves the specified zone-specific Operations resource. + * @desc Retrieves the specified zone-specific Operations resource. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -76881,7 +77490,7 @@ export namespace compute_v1 { /** * compute.zoneOperations.list - * @desc Retrieves a list of Operation resources contained within the specified zone. + * @desc Retrieves a list of Operation resources contained within the specified zone. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -77105,7 +77714,7 @@ export namespace compute_v1 { /** * compute.zones.get - * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. + * @desc Returns the specified Zone resource. Gets a list of available zones by making a list() request. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- @@ -77229,7 +77838,7 @@ export namespace compute_v1 { /** * compute.zones.list - * @desc Retrieves the list of Zone resources available to the specified project. + * @desc Retrieves the list of Zone resources available to the specified project. (== suppress_warning http-rest-shadowed ==) * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index ef4eb09555d..14a237b05fd 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -151,6 +151,32 @@ export namespace container_v1 { */ networkPolicyConfig?: Schema$NetworkPolicyConfig; } + /** + * Configuration for returning group information from authenticators. + */ + export interface Schema$AuthenticatorGroupsConfig { + /** + * Whether this cluster should return group membership lookups during authentication using a group of security groups. + */ + enabled?: boolean | null; + /** + * The name of the security group-of-groups to be used. Only relevant if enabled = true. + */ + securityGroup?: string | null; + } + /** + * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. + */ + export interface Schema$AutoprovisioningNodePoolDefaults { + /** + * Scopes that are used by NAP when creating node pools. If oauth_scopes are specified, service_account should be empty. + */ + oauthScopes?: string[] | null; + /** + * 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; + } /** * AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. */ @@ -173,6 +199,15 @@ export namespace container_v1 { */ datasetId?: string | null; } + /** + * Configuration for Binary Authorization. + */ + export interface Schema$BinaryAuthorization { + /** + * Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization. + */ + enabled?: boolean | null; + } /** * CancelOperationRequest cancels a single operation. */ @@ -224,6 +259,18 @@ export namespace container_v1 { * Configurations for the various addons available to run in the cluster. */ addonsConfig?: Schema$AddonsConfig; + /** + * Configuration controlling RBAC group membership information. + */ + authenticatorGroupsConfig?: Schema$AuthenticatorGroupsConfig; + /** + * Cluster-level autoscaling configuration. + */ + autoscaling?: Schema$ClusterAutoscaling; + /** + * Configuration for Binary Authorization. + */ + binaryAuthorization?: Schema$BinaryAuthorization; /** * The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`. */ @@ -248,6 +295,10 @@ export namespace container_v1 { * [Output only] Deprecated, use [NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ currentNodeVersion?: string | null; + /** + * Configuration of etcd encryption. + */ + databaseEncryption?: Schema$DatabaseEncryption; /** * The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support. */ @@ -305,7 +356,7 @@ export namespace container_v1 { */ locations?: string[] | null; /** - * The logging service the cluster should use to write logs. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used. + * The logging service the cluster should use to write logs. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used. */ loggingService?: string | null; /** @@ -325,7 +376,7 @@ export namespace container_v1 { */ monitoringService?: string | null; /** - * The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. + * The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. */ name?: string | null; /** @@ -388,11 +439,36 @@ export namespace container_v1 { * [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ tpuIpv4CidrBlock?: string | null; + /** + * Cluster-level Vertical Pod Autoscaling configuration. + */ + verticalPodAutoscaling?: Schema$VerticalPodAutoscaling; /** * [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ zone?: string | null; } + /** + * ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. + */ + export interface Schema$ClusterAutoscaling { + /** + * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + */ + autoprovisioningLocations?: string[] | null; + /** + * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. + */ + autoprovisioningNodePoolDefaults?: Schema$AutoprovisioningNodePoolDefaults; + /** + * Enables automatic node pool creation and deletion. + */ + enableNodeAutoprovisioning?: boolean | null; + /** + * Contains global constraints regarding minimum and maximum amount of resources in the cluster. + */ + resourceLimits?: Schema$ResourceLimit[]; + } /** * ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. */ @@ -401,6 +477,18 @@ export namespace container_v1 { * Configurations for the various addons available to run in the cluster. */ desiredAddonsConfig?: Schema$AddonsConfig; + /** + * The desired configuration options for the Binary Authorization feature. + */ + desiredBinaryAuthorization?: Schema$BinaryAuthorization; + /** + * Cluster-level autoscaling configuration. + */ + desiredClusterAutoscaling?: Schema$ClusterAutoscaling; + /** + * Configuration of etcd encryption. + */ + desiredDatabaseEncryption?: Schema$DatabaseEncryption; /** * The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. */ @@ -414,7 +502,7 @@ export namespace container_v1 { */ desiredLocations?: string[] | null; /** - * The logging service the cluster should use to write logs. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster + * The logging service the cluster should use to write logs. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster */ desiredLoggingService?: string | null; /** @@ -426,7 +514,7 @@ export namespace container_v1 { */ desiredMasterVersion?: string | null; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ desiredMonitoringService?: string | null; /** @@ -445,6 +533,10 @@ export namespace container_v1 { * The desired configuration for exporting resource usage. */ desiredResourceUsageExportConfig?: Schema$ResourceUsageExportConfig; + /** + * Cluster-level Vertical Pod Autoscaling configuration. + */ + desiredVerticalPodAutoscaling?: Schema$VerticalPodAutoscaling; } /** * CompleteIPRotationRequest moves the cluster master back into single-IP mode. @@ -535,6 +627,19 @@ export namespace container_v1 { */ startTime?: string | null; } + /** + * Configuration of etcd encryption. + */ + export interface Schema$DatabaseEncryption { + /** + * Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key + */ + keyName?: string | null; + /** + * Denotes the state of etcd encryption. + */ + state?: 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 `{}`. */ @@ -953,6 +1058,10 @@ export namespace container_v1 { * The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. */ serviceAccount?: string | null; + /** + * Shielded Instance options. + */ + shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; /** * The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. */ @@ -1040,6 +1149,10 @@ export namespace container_v1 { * NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. */ export interface Schema$NodePoolAutoscaling { + /** + * Can this node pool be deleted automatically. + */ + autoprovisioned?: boolean | null; /** * Is autoscaling enabled for this node pool. */ @@ -1152,6 +1265,23 @@ export namespace container_v1 { */ publicEndpoint?: string | null; } + /** + * Contains information about amount of some resource in the cluster. For memory, value should be in GB. + */ + export interface Schema$ResourceLimit { + /** + * Maximum amount of the resource in the cluster. + */ + maximum?: string | null; + /** + * Minimum amount of the resource in the cluster. + */ + minimum?: string | null; + /** + * Resource name "cpu", "memory" or gpu-specific string. + */ + resourceType?: string | null; + } /** * Configuration for exporting cluster resource usages. */ @@ -1411,7 +1541,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ monitoringService?: string | null; /** @@ -1539,6 +1669,19 @@ export namespace container_v1 { */ zone?: string | null; } + /** + * A set of Shielded Instance options. + */ + export interface Schema$ShieldedInstanceConfig { + /** + * Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. + */ + enableIntegrityMonitoring?: boolean | null; + /** + * Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. + */ + enableSecureBoot?: boolean | 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. */ @@ -1702,6 +1845,15 @@ export namespace container_v1 { */ status?: string | null; } + /** + * VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. + */ + export interface Schema$VerticalPodAutoscaling { + /** + * Enables vertical pod autoscaling. + */ + enabled?: boolean | null; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index dcc4e18f88f..72ce6cad193 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -126,7 +126,7 @@ export namespace container_v1beta1 { */ acceleratorCount?: string | null; /** - * The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus/#Introduction) + * The accelerator type resource name. List of supported accelerators [here](/compute/docs/gpus) */ acceleratorType?: string | null; } @@ -176,6 +176,10 @@ export namespace container_v1beta1 { * 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. */ @@ -184,6 +188,10 @@ export namespace container_v1beta1 { * 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. @@ -397,7 +405,7 @@ export namespace container_v1beta1 { */ monitoringService?: string | null; /** - * The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. + * The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. */ name?: string | null; /** @@ -547,7 +555,7 @@ export namespace container_v1beta1 { */ desiredLocations?: string[] | null; /** - * The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model in Stackdriver * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster + * The logging service the cluster should use to write metrics. Currently available options: * "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster */ desiredLoggingService?: string | null; /** @@ -559,7 +567,7 @@ export namespace container_v1beta1 { */ desiredMasterVersion?: string | null; /** - * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model in Stackdriver * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster + * The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster */ desiredMonitoringService?: string | null; /** @@ -1023,6 +1031,10 @@ export namespace container_v1beta1 { * MaintenancePolicy defines the maintenance policy to be used for the cluster. */ export interface Schema$MaintenancePolicy { + /** + * A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a <code>get()</code> request to the cluster to get the current resource version and include it with requests to set the policy. + */ + resourceVersion?: string | null; /** * Specifies the maintenance window in which maintenance may be performed. */ @@ -1036,6 +1048,14 @@ export namespace container_v1beta1 { * DailyMaintenanceWindow specifies a daily maintenance operation window. */ dailyMaintenanceWindow?: Schema$DailyMaintenanceWindow; + /** + * Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. + */ + maintenanceExclusions?: {[key: string]: Schema$TimeWindow} | null; + /** + * RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time. + */ + recurringWindow?: Schema$RecurringTimeWindow; } /** * The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. @@ -1170,7 +1190,7 @@ export namespace container_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information. + * The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. */ localSsdCount?: number | null; /** @@ -1291,6 +1311,10 @@ export namespace container_v1beta1 { * [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. */ @@ -1458,6 +1482,10 @@ export namespace container_v1beta1 { * 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. */ @@ -1467,6 +1495,19 @@ export namespace container_v1beta1 { */ publicEndpoint?: string | null; } + /** + * Represents an arbitrary window of time that recurs. + */ + export interface Schema$RecurringTimeWindow { + /** + * An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: <code>FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR</code> To repeat some window daily (equivalent to the DailyMaintenanceWindow): <code>FREQ=DAILY</code> For the first weekend of every month: <code>FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU</code> This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: <code> start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR </code> Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: <code> start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA </code> Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported. + */ + recurrence?: string | null; + /** + * The window of the first recurrence. + */ + window?: Schema$TimeWindow; + } /** * ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk and frequency of updates. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. Updates to version related fields (e.g. current_master_version) return an error. */ @@ -1992,6 +2033,19 @@ export namespace container_v1beta1 { */ tier?: string | null; } + /** + * Represents an arbitrary window of time. + */ + export interface Schema$TimeWindow { + /** + * The time that the window ends. The end time should take place after the start time. + */ + endTime?: string | null; + /** + * The time that the window first starts. + */ + startTime?: string | null; + } /** * UpdateClusterRequest updates the settings of a cluster. */ @@ -2074,6 +2128,10 @@ export namespace container_v1beta1 { * Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; + /** + * Upgrade settings control disruption and speed of the upgrade. + */ + upgradeSettings?: Schema$UpgradeSettings; /** * The desired image type for the node pool. */ @@ -2083,6 +2141,19 @@ export namespace container_v1beta1 { */ 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. */ diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 40258cb68f2..8f7073e3a71 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -457,6 +457,10 @@ export namespace containeranalysis_v1alpha1 { * Whether the resource is continuously analyzed. */ continuousAnalysis?: string | null; + /** + * The CPE of the resource being scanned. + */ + cpe?: string | null; /** * Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. */ @@ -565,7 +569,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; } @@ -1018,19 +1022,19 @@ export namespace containeranalysis_v1alpha1 { signature?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Deprecated. + * 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. */ version?: number | null; } diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index 1ce5db4d697..f72a29e0bea 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -475,7 +475,7 @@ export namespace containeranalysis_v1beta1 { */ isObsolete?: boolean | null; /** - * Deprecated, do not use. Use fixed_location instead. The max version of the package in which the vulnerability exists. + * The max version of the package in which the vulnerability exists. */ maxAffectedVersion?: Schema$Version; /** @@ -691,7 +691,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; } @@ -1112,19 +1112,19 @@ export namespace containeranalysis_v1beta1 { signature?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Deprecated. + * 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. */ version?: number | null; } diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 793e5a8a4de..c932ccbed2c 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -134,7 +134,7 @@ export namespace content_v2_1 { } /** - * Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role. + * Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. */ export interface Schema$Account { /** @@ -1158,7 +1158,7 @@ export namespace content_v2_1 { */ excludedDestinations?: string[] | null; /** - * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle */ includedDestinations?: string[] | null; /** @@ -1645,7 +1645,7 @@ export namespace content_v2_1 { state?: string | null; } /** - * Order. All methods require the order manager role. + * Order. Production access (all methods) requires the order manager role. Sandbox access does not. */ export interface Schema$Order { /** @@ -2182,11 +2182,15 @@ export namespace content_v2_1 { */ applicableItems?: Schema$OrderPromotionItem[]; /** - * Items which this promotion have been applied to. + * Items which this promotion have been applied to. Do not provide for orders.createtestorder. */ appliedItems?: Schema$OrderPromotionItem[]; /** - * The party funding the promotion. + * Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z". + */ + endTime?: string | null; + /** + * The party funding the promotion. Only merchant is supported for orders.createtestorder. */ funder?: string | null; /** @@ -2198,15 +2202,19 @@ export namespace content_v2_1 { */ priceValue?: Schema$Price; /** - * A short title of the promotion to be shown on the checkout page. + * A short title of the promotion to be shown on the checkout page. Do not provide for orders.createtestorder. */ shortTitle?: string | null; /** - * The category of the promotion. + * Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z". + */ + startTime?: string | null; + /** + * The category of the promotion. Only moneyOff is supported for orders.createtestorder. */ subtype?: string | null; /** - * Estimated discount applied to tax (if allowed by law). + * Estimated discount applied to tax (if allowed by law). Do not provide for orders.createtestorder. */ taxValue?: Schema$Price; /** @@ -2214,15 +2222,25 @@ export namespace content_v2_1 { */ title?: string | null; /** - * The scope of the promotion. + * The scope of the promotion. Only product is supported for orders.createtestorder. */ type?: string | null; } export interface Schema$OrderPromotionItem { + /** + * The line item ID of a product. Do not provide for orders.createtestorder. + */ lineItemId?: string | null; + /** + * Offer ID of a product. Only for orders.createtestorder. + */ + offerId?: string | null; + /** + * orders.createtestorder. + */ productId?: string | null; /** - * The quantity of the associated product. + * The quantity of the associated product. Do not provide for orders.createtestorder. */ quantity?: number | null; } @@ -2552,7 +2570,7 @@ export namespace content_v2_1 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" - "colis prive" - "boxtal" - "geodis" + * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" - "jd logistics" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" - "colis prive" - "boxtal" - "geodis" - "tnt" - "la poste" */ carrier?: string | null; /** @@ -3528,7 +3546,7 @@ export namespace content_v2_1 { */ shippingWidth?: Schema$ProductShippingDimension; /** - * Size of the item. + * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value (see size definition). */ sizes?: string[] | null; /** diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 2634620ddd3..d3e02bc1698 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -97,7 +97,6 @@ export namespace content_v2 { inventory: Resource$Inventory; liasettings: Resource$Liasettings; orderinvoices: Resource$Orderinvoices; - orderpayments: Resource$Orderpayments; orderreports: Resource$Orderreports; orderreturns: Resource$Orderreturns; orders: Resource$Orders; @@ -120,7 +119,6 @@ export namespace content_v2 { this.inventory = new Resource$Inventory(this.context); this.liasettings = new Resource$Liasettings(this.context); this.orderinvoices = new Resource$Orderinvoices(this.context); - this.orderpayments = new Resource$Orderpayments(this.context); this.orderreports = new Resource$Orderreports(this.context); this.orderreturns = new Resource$Orderreturns(this.context); this.orders = new Resource$Orders(this.context); @@ -132,7 +130,7 @@ export namespace content_v2 { } /** - * Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role. + * Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. */ export interface Schema$Account { /** @@ -1214,7 +1212,7 @@ export namespace content_v2 { */ excludedDestinations?: string[] | null; /** - * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle */ includedDestinations?: string[] | null; /** @@ -1919,7 +1917,7 @@ export namespace content_v2 { state?: string | null; } /** - * Order. All methods require the order manager role. + * Order. Production access (all methods) requires the order manager role. Sandbox access does not. */ export interface Schema$Order { /** @@ -2481,90 +2479,6 @@ export namespace content_v2 { */ type?: string | null; } - export interface Schema$OrderpaymentsNotifyAuthApprovedRequest { - /** - * Authorized amount for pre-tax charge on user's credit card. - */ - authAmountPretax?: Schema$Price; - /** - * Authorized amount for tax charge on user's credit card. - */ - authAmountTax?: Schema$Price; - } - export interface Schema$OrderpaymentsNotifyAuthApprovedResponse { - /** - * The status of the execution. - */ - executionStatus?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthApprovedResponse". - */ - kind?: string | null; - } - export interface Schema$OrderpaymentsNotifyAuthDeclinedRequest { - /** - * Reason why payment authorization was declined. - */ - declineReason?: string | null; - } - export interface Schema$OrderpaymentsNotifyAuthDeclinedResponse { - /** - * The status of the execution. - */ - executionStatus?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthDeclinedResponse". - */ - kind?: string | null; - } - export interface Schema$OrderpaymentsNotifyChargeRequest { - /** - * Whether charge was successful. - */ - chargeState?: string | null; - /** - * Deprecated. Please use invoiceIds instead. - */ - invoiceId?: string | null; - /** - * Invoice IDs from the orderinvoices service that correspond to the charge. - */ - invoiceIds?: string[] | null; - } - export interface Schema$OrderpaymentsNotifyChargeResponse { - /** - * The status of the execution. - */ - executionStatus?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyChargeResponse". - */ - kind?: string | null; - } - export interface Schema$OrderpaymentsNotifyRefundRequest { - /** - * Deprecated. Please use invoiceIds instead. - */ - invoiceId?: string | null; - /** - * Invoice IDs from the orderinvoices service that correspond to the refund. - */ - invoiceIds?: string[] | null; - /** - * Whether refund was successful. - */ - refundState?: string | null; - } - export interface Schema$OrderpaymentsNotifyRefundResponse { - /** - * The status of the execution. - */ - executionStatus?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyRefundResponse". - */ - kind?: string | null; - } export interface Schema$OrderPickupDetails { /** * Address of the pickup location where the shipment should be sent. Note that recipientName in the address is the name of the business at the pickup location. @@ -3286,7 +3200,7 @@ export namespace content_v2 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" - "colis prive" - "boxtal" - "geodis" + * The carrier handling the shipment. Acceptable values for US are: - "gsx" - "ups" - "usps" - "fedex" - "dhl" - "ecourier" - "cxt" - "google" - "ontrac" - "emsy" - "ont" - "deliv" - "dynamex" - "lasership" - "mpx" - "uds" - "efw" - "jd logistics" Acceptable values for FR are: - "colissimo" - "chronopost" - "gls" - "dpd" - "bpost" - "colis prive" - "boxtal" - "geodis" - "tnt" - "la poste" */ carrier?: string | null; /** @@ -4354,7 +4268,7 @@ export namespace content_v2 { */ shippingWidth?: Schema$ProductShippingDimension; /** - * Size of the item. + * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value (see size definition). */ sizes?: string[] | null; /** @@ -5941,79 +5855,6 @@ export namespace content_v2 { } } - /** - * content.accounts.patch - * @desc Updates a Merchant Center account. This method supports patch semantics. - * @alias content.accounts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.accountId The ID of the account. - * @param {boolean=} params.dryRun Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - * @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 {().Account} params.resource Request body data - * @param {object} [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$Accounts$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accounts$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Accounts$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/content/v2/{merchantId}/accounts/{accountId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - 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. @@ -6229,30 +6070,6 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Accounts$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the account. - */ - accountId?: string; - /** - * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - */ - dryRun?: boolean; - /** - * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. - */ - merchantId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request @@ -6824,81 +6641,6 @@ export namespace content_v2 { } } - /** - * content.accounttax.patch - * @desc Updates the tax settings of the account. This method supports patch semantics. - * @alias content.accounttax.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.accountId The ID of the account for which to get/update account tax settings. - * @param {boolean=} params.dryRun Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - * @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 {().AccountTax} params.resource Request body data - * @param {object} [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$Accounttax$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounttax$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accounttax$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Accounttax$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounttax$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounttax$Patch; - 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}/accounttax/{accountId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['merchantId', 'accountId'], - pathParams: ['accountId', 'merchantId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * content.accounttax.update * @desc Updates the tax settings of the account. @@ -7027,30 +6769,6 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Accounttax$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the account for which to get/update account tax settings. - */ - accountId?: string; - /** - * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - */ - dryRun?: boolean; - /** - * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. - */ - merchantId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountTax; - } export interface Params$Resource$Accounttax$Update extends StandardParameters { /** @@ -7544,9 +7262,9 @@ export namespace content_v2 { } /** - * content.datafeeds.patch - * @desc Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics. - * @alias content.datafeeds.patch + * content.datafeeds.update + * @desc Updates a datafeed configuration of your Merchant Center account. + * @alias content.datafeeds.update * @memberOf! () * * @param {object} params Parameters for request @@ -7558,33 +7276,33 @@ export namespace content_v2 { * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - patch( - params?: Params$Resource$Datafeeds$Patch, + update( + params?: Params$Resource$Datafeeds$Update, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Datafeeds$Patch, + update( + params: Params$Resource$Datafeeds$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Datafeeds$Patch, + update( + params: Params$Resource$Datafeeds$Update, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Datafeeds$Patch + | Params$Resource$Datafeeds$Update | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Datafeeds$Patch; + let params = (paramsOrCallback || {}) as Params$Resource$Datafeeds$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datafeeds$Patch; + params = {} as Params$Resource$Datafeeds$Update; options = {}; } @@ -7600,7 +7318,7 @@ export namespace content_v2 { url: ( rootUrl + '/content/v2/{merchantId}/datafeeds/{datafeedId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'PUT', }, options ), @@ -7615,85 +7333,12 @@ export namespace content_v2 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Datafeeds$Custombatch + extends StandardParameters { /** - * content.datafeeds.update - * @desc Updates a datafeed configuration of your Merchant Center account. - * @alias content.datafeeds.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.datafeedId The ID of the datafeed. - * @param {boolean=} params.dryRun Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - * @param {string} params.merchantId The ID of the account that manages the datafeed. This account cannot be a multi-client account. - * @param {().Datafeed} params.resource Request body data - * @param {object} [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$Datafeeds$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Datafeeds$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Datafeeds$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Datafeeds$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Datafeeds$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Datafeeds$Update; - 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}/datafeeds/{datafeedId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['merchantId', 'datafeedId'], - pathParams: ['datafeedId', 'merchantId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Datafeeds$Custombatch - extends StandardParameters { - /** - * Auth client or API Key for the request + * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; @@ -7800,30 +7445,6 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Datafeeds$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the datafeed. - */ - datafeedId?: string; - /** - * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - */ - dryRun?: boolean; - /** - * The ID of the account that manages the datafeed. This account cannot be a multi-client account. - */ - merchantId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Datafeed; - } export interface Params$Resource$Datafeeds$Update extends StandardParameters { /** * Auth client or API Key for the request @@ -8804,82 +8425,6 @@ export namespace content_v2 { } } - /** - * content.liasettings.patch - * @desc Updates the LIA settings of the account. This method supports patch semantics. - * @alias content.liasettings.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.accountId The ID of the account for which to get or update LIA settings. - * @param {boolean=} params.dryRun Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - * @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 {().LiaSettings} params.resource Request body data - * @param {object} [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$Liasettings$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Liasettings$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Liasettings$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Liasettings$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Liasettings$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Liasettings$Patch; - 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}/liasettings/{accountId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['merchantId', 'accountId'], - pathParams: ['accountId', 'merchantId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * content.liasettings.requestgmbaccess * @desc Requests access to a specified Google My Business account. @@ -9423,31 +8968,6 @@ export namespace content_v2 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; } - export interface Params$Resource$Liasettings$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the account for which to get or update LIA settings. - */ - accountId?: string; - /** - * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - */ - dryRun?: boolean; - /** - * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. - */ - merchantId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LiaSettings; - } export interface Params$Resource$Liasettings$Requestgmbaccess extends StandardParameters { /** @@ -9581,475 +9101,61 @@ export namespace content_v2 { } /** - * content.orderinvoices.createchargeinvoice - * @desc Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders. - * @alias content.orderinvoices.createchargeinvoice - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrderinvoicesCreateChargeInvoiceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - createchargeinvoice( - params?: Params$Resource$Orderinvoices$Createchargeinvoice, - options?: MethodOptions - ): GaxiosPromise; - createchargeinvoice( - params: Params$Resource$Orderinvoices$Createchargeinvoice, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateChargeInvoiceResponse - > - ): void; - createchargeinvoice( - params: Params$Resource$Orderinvoices$Createchargeinvoice, - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateChargeInvoiceResponse - > - ): void; - createchargeinvoice( - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateChargeInvoiceResponse - > - ): void; - createchargeinvoice( - paramsOrCallback?: - | Params$Resource$Orderinvoices$Createchargeinvoice - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OrderinvoicesCreateChargeInvoiceResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Orderinvoices$Createchargeinvoice; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderinvoices$Createchargeinvoice; - 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}/orderinvoices/{orderId}/createChargeInvoice' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$OrderinvoicesCreateChargeInvoiceResponse - >(parameters); - } - } - - /** - * content.orderinvoices.createrefundinvoice - * @desc Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice. - * @alias content.orderinvoices.createrefundinvoice - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order. - * @param {().OrderinvoicesCreateRefundInvoiceRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - createrefundinvoice( - params?: Params$Resource$Orderinvoices$Createrefundinvoice, - options?: MethodOptions - ): GaxiosPromise; - createrefundinvoice( - params: Params$Resource$Orderinvoices$Createrefundinvoice, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateRefundInvoiceResponse - > - ): void; - createrefundinvoice( - params: Params$Resource$Orderinvoices$Createrefundinvoice, - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateRefundInvoiceResponse - > - ): void; - createrefundinvoice( - callback: BodyResponseCallback< - Schema$OrderinvoicesCreateRefundInvoiceResponse - > - ): void; - createrefundinvoice( - paramsOrCallback?: - | Params$Resource$Orderinvoices$Createrefundinvoice - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OrderinvoicesCreateRefundInvoiceResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Orderinvoices$Createrefundinvoice; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderinvoices$Createrefundinvoice; - 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}/orderinvoices/{orderId}/createRefundInvoice' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$OrderinvoicesCreateRefundInvoiceResponse - >(parameters); - } - } - } - - export interface Params$Resource$Orderinvoices$Createchargeinvoice - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderinvoicesCreateChargeInvoiceRequest; - } - export interface Params$Resource$Orderinvoices$Createrefundinvoice - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a multi-client account. - */ - merchantId?: string; - /** - * The ID of the order. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderinvoicesCreateRefundInvoiceRequest; - } - - export class Resource$Orderpayments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * content.orderpayments.notifyauthapproved - * @desc Notify about successfully authorizing user's payment method for a given amount. - * @alias content.orderpayments.notifyauthapproved - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order for for which payment authorization is happening. - * @param {().OrderpaymentsNotifyAuthApprovedRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - notifyauthapproved( - params?: Params$Resource$Orderpayments$Notifyauthapproved, - options?: MethodOptions - ): GaxiosPromise; - notifyauthapproved( - params: Params$Resource$Orderpayments$Notifyauthapproved, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthApprovedResponse - > - ): void; - notifyauthapproved( - params: Params$Resource$Orderpayments$Notifyauthapproved, - callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthApprovedResponse - > - ): void; - notifyauthapproved( - callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthApprovedResponse - > - ): void; - notifyauthapproved( - paramsOrCallback?: - | Params$Resource$Orderpayments$Notifyauthapproved - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthApprovedResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Orderpayments$Notifyauthapproved; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderpayments$Notifyauthapproved; - 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}/orderpayments/{orderId}/notifyAuthApproved' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * content.orderpayments.notifyauthdeclined - * @desc Notify about failure to authorize user's payment method. - * @alias content.orderpayments.notifyauthdeclined + * content.orderinvoices.createchargeinvoice + * @desc Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders. + * @alias content.orderinvoices.createchargeinvoice * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order for which payment authorization was declined. - * @param {().OrderpaymentsNotifyAuthDeclinedRequest} params.resource Request body data + * @param {string} params.orderId The ID of the order. + * @param {().OrderinvoicesCreateChargeInvoiceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - notifyauthdeclined( - params?: Params$Resource$Orderpayments$Notifyauthdeclined, + createchargeinvoice( + params?: Params$Resource$Orderinvoices$Createchargeinvoice, options?: MethodOptions - ): GaxiosPromise; - notifyauthdeclined( - params: Params$Resource$Orderpayments$Notifyauthdeclined, + ): GaxiosPromise; + createchargeinvoice( + params: Params$Resource$Orderinvoices$Createchargeinvoice, options: | MethodOptions - | BodyResponseCallback, + | BodyResponseCallback, callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthDeclinedResponse + Schema$OrderinvoicesCreateChargeInvoiceResponse > ): void; - notifyauthdeclined( - params: Params$Resource$Orderpayments$Notifyauthdeclined, + createchargeinvoice( + params: Params$Resource$Orderinvoices$Createchargeinvoice, callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthDeclinedResponse + Schema$OrderinvoicesCreateChargeInvoiceResponse > ): void; - notifyauthdeclined( + createchargeinvoice( callback: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthDeclinedResponse + Schema$OrderinvoicesCreateChargeInvoiceResponse > ): void; - notifyauthdeclined( + createchargeinvoice( paramsOrCallback?: - | Params$Resource$Orderpayments$Notifyauthdeclined - | BodyResponseCallback, + | Params$Resource$Orderinvoices$Createchargeinvoice + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, + | BodyResponseCallback, callback?: BodyResponseCallback< - Schema$OrderpaymentsNotifyAuthDeclinedResponse + Schema$OrderinvoicesCreateChargeInvoiceResponse > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Orderpayments$Notifyauthdeclined; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderpayments$Notifyauthdeclined; - 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}/orderpayments/{orderId}/notifyAuthDeclined' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['merchantId', 'orderId'], - pathParams: ['merchantId', 'orderId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * content.orderpayments.notifycharge - * @desc Notify about charge on user's selected payments method. - * @alias content.orderpayments.notifycharge - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order for which charge is happening. - * @param {().OrderpaymentsNotifyChargeRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - notifycharge( - params?: Params$Resource$Orderpayments$Notifycharge, - options?: MethodOptions - ): GaxiosPromise; - notifycharge( - params: Params$Resource$Orderpayments$Notifycharge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - notifycharge( - params: Params$Resource$Orderpayments$Notifycharge, - callback: BodyResponseCallback - ): void; - notifycharge( - callback: BodyResponseCallback - ): void; - notifycharge( - paramsOrCallback?: - | Params$Resource$Orderpayments$Notifycharge - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Orderpayments$Notifycharge; + {}) as Params$Resource$Orderinvoices$Createchargeinvoice; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Orderpayments$Notifycharge; + params = {} as Params$Resource$Orderinvoices$Createchargeinvoice; options = {}; } @@ -10064,7 +9170,7 @@ export namespace content_v2 { { url: ( rootUrl + - '/content/v2/{merchantId}/orderpayments/{orderId}/notifyCharge' + '/content/v2/{merchantId}/orderinvoices/{orderId}/createChargeInvoice' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -10076,65 +9182,73 @@ export namespace content_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest< + Schema$OrderinvoicesCreateChargeInvoiceResponse + >(parameters); } } /** - * content.orderpayments.notifyrefund - * @desc Notify about refund on user's selected payments method. - * @alias content.orderpayments.notifyrefund + * content.orderinvoices.createrefundinvoice + * @desc Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice. + * @alias content.orderinvoices.createrefundinvoice * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.merchantId The ID of the account that manages the order. This cannot be a multi-client account. - * @param {string} params.orderId The ID of the order for which charge is happening. - * @param {().OrderpaymentsNotifyRefundRequest} params.resource Request body data + * @param {string} params.orderId The ID of the order. + * @param {().OrderinvoicesCreateRefundInvoiceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - notifyrefund( - params?: Params$Resource$Orderpayments$Notifyrefund, + createrefundinvoice( + params?: Params$Resource$Orderinvoices$Createrefundinvoice, options?: MethodOptions - ): GaxiosPromise; - notifyrefund( - params: Params$Resource$Orderpayments$Notifyrefund, + ): GaxiosPromise; + createrefundinvoice( + params: Params$Resource$Orderinvoices$Createrefundinvoice, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$OrderinvoicesCreateRefundInvoiceResponse + > ): void; - notifyrefund( - params: Params$Resource$Orderpayments$Notifyrefund, - callback: BodyResponseCallback + createrefundinvoice( + params: Params$Resource$Orderinvoices$Createrefundinvoice, + callback: BodyResponseCallback< + Schema$OrderinvoicesCreateRefundInvoiceResponse + > ): void; - notifyrefund( - callback: BodyResponseCallback + createrefundinvoice( + callback: BodyResponseCallback< + Schema$OrderinvoicesCreateRefundInvoiceResponse + > ): void; - notifyrefund( + createrefundinvoice( paramsOrCallback?: - | Params$Resource$Orderpayments$Notifyrefund - | BodyResponseCallback, + | Params$Resource$Orderinvoices$Createrefundinvoice + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$OrderinvoicesCreateRefundInvoiceResponse + > + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Orderpayments$Notifyrefund; + {}) as Params$Resource$Orderinvoices$Createrefundinvoice; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Orderpayments$Notifyrefund; + params = {} as Params$Resource$Orderinvoices$Createrefundinvoice; options = {}; } @@ -10149,7 +9263,7 @@ export namespace content_v2 { { url: ( rootUrl + - '/content/v2/{merchantId}/orderpayments/{orderId}/notifyRefund' + '/content/v2/{merchantId}/orderinvoices/{orderId}/createRefundInvoice' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -10161,61 +9275,19 @@ export namespace content_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest< + Schema$OrderinvoicesCreateRefundInvoiceResponse + >(parameters); } } } - export interface Params$Resource$Orderpayments$Notifyauthapproved - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a multi-client account. - */ - merchantId?: string; - /** - * The ID of the order for for which payment authorization is happening. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderpaymentsNotifyAuthApprovedRequest; - } - export interface Params$Resource$Orderpayments$Notifyauthdeclined - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the account that manages the order. This cannot be a multi-client account. - */ - merchantId?: string; - /** - * The ID of the order for which payment authorization was declined. - */ - orderId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$OrderpaymentsNotifyAuthDeclinedRequest; - } - export interface Params$Resource$Orderpayments$Notifycharge + export interface Params$Resource$Orderinvoices$Createchargeinvoice extends StandardParameters { /** * Auth client or API Key for the request @@ -10227,16 +9299,16 @@ export namespace content_v2 { */ merchantId?: string; /** - * The ID of the order for which charge is happening. + * The ID of the order. */ orderId?: string; /** * Request body metadata */ - requestBody?: Schema$OrderpaymentsNotifyChargeRequest; + requestBody?: Schema$OrderinvoicesCreateChargeInvoiceRequest; } - export interface Params$Resource$Orderpayments$Notifyrefund + export interface Params$Resource$Orderinvoices$Createrefundinvoice extends StandardParameters { /** * Auth client or API Key for the request @@ -10248,14 +9320,14 @@ export namespace content_v2 { */ merchantId?: string; /** - * The ID of the order for which charge is happening. + * The ID of the order. */ orderId?: string; /** * Request body metadata */ - requestBody?: Schema$OrderpaymentsNotifyRefundRequest; + requestBody?: Schema$OrderinvoicesCreateRefundInvoiceRequest; } export class Resource$Orderreports { @@ -14962,82 +14034,6 @@ export namespace content_v2 { } } - /** - * content.shippingsettings.patch - * @desc Updates the shipping settings of the account. This method supports patch semantics. - * @alias content.shippingsettings.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.accountId The ID of the account for which to get/update shipping settings. - * @param {boolean=} params.dryRun Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - * @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 {().ShippingSettings} params.resource Request body data - * @param {object} [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$Shippingsettings$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Shippingsettings$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Shippingsettings$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Shippingsettings$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Shippingsettings$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Shippingsettings$Patch; - 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}/shippingsettings/{accountId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['merchantId', 'accountId'], - pathParams: ['accountId', 'merchantId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * content.shippingsettings.update * @desc Updates the shipping settings of the account. @@ -15192,31 +14188,6 @@ export namespace content_v2 { */ pageToken?: string; } - export interface Params$Resource$Shippingsettings$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the account for which to get/update shipping settings. - */ - accountId?: string; - /** - * Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any). - */ - dryRun?: boolean; - /** - * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. - */ - merchantId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ShippingSettings; - } export interface Params$Resource$Shippingsettings$Update extends StandardParameters { /** diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 2a873562ef2..1da3890badc 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -726,6 +726,14 @@ export namespace dataflow_v1b3 { * The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. */ workerPools?: Schema$WorkerPool[]; + /** + * The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. + */ + workerRegion?: string | null; + /** + * The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. + */ + workerZone?: string | null; } /** * A message describing the state of a particular execution stage. @@ -1772,6 +1780,10 @@ export namespace dataflow_v1b3 { * Whether to bypass the safety checks for the job's temporary directory. Use with caution. */ bypassTempDirValidation?: boolean | null; + /** + * Configuration for VM IPs. + */ + ipConfiguration?: string | null; /** * Optional. Name for the Cloud KMS key for the job. Key format is: projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key> */ @@ -1805,11 +1817,15 @@ export namespace dataflow_v1b3 { */ tempLocation?: string | null; /** - * Optional. Specifies whether worker pools should be started with private IP addresses. False by default. + * The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. + */ + workerRegion?: string | null; + /** + * The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence. */ - usePrivateIps?: boolean | null; + workerZone?: string | null; /** - * The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. + * The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence. */ zone?: string | null; } diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index d3f21fb7c81..d953306ce19 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -118,7 +118,7 @@ export namespace datafusion_v1beta1 { } /** - * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. */ export interface Schema$AuditConfig { /** @@ -132,13 +132,14 @@ export namespace datafusion_v1beta1 { service?: string | null; } /** - * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ export interface Schema$AuditLogConfig { /** * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[] | null; + ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. */ @@ -162,7 +163,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@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -213,9 +214,13 @@ export namespace datafusion_v1beta1 { 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/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). + * 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. */ @@ -225,6 +230,19 @@ export namespace datafusion_v1beta1 { */ 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 */ @@ -263,6 +281,14 @@ export namespace datafusion_v1beta1 { * Represents a Data Fusion instance. */ export interface Schema$Instance { + /** + * Output only. Endpoint on which the REST APIs is accessible. + */ + apiEndpoint?: string | null; + /** + * Available versions that the instance can be upgraded to using UpdateInstanceRequest. + */ + availableVersion?: Schema$Version[]; /** * Output only. The time the instance was created. */ @@ -308,7 +334,7 @@ export namespace datafusion_v1beta1 { */ serviceAccount?: string | null; /** - * Output only. Endpoint on which the Data Fusion UI and REST APIs are accessible. + * Output only. Endpoint on which the Data Fusion UI is accessible. */ serviceEndpoint?: string | null; /** @@ -328,7 +354,7 @@ export namespace datafusion_v1beta1 { */ updateTime?: string | null; /** - * Output only. Current version of the Data Fusion. + * Current version of the Data Fusion. Only specifiable in Update. */ version?: string | null; /** @@ -430,7 +456,7 @@ export namespace datafusion_v1beta1 { */ ipAllocation?: string | null; /** - * Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. + * Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network} */ network?: string | null; } @@ -493,7 +519,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` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -501,11 +527,11 @@ export namespace datafusion_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ bindings?: Schema$Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. 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?: string | null; iamOwned?: boolean | null; @@ -514,7 +540,7 @@ export namespace datafusion_v1beta1 { */ rules?: Schema$Rule[]; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -607,6 +633,15 @@ export namespace datafusion_v1beta1 { * Request message for upgrading a Data Fusion instance. To change the instance properties, instance update should be used. */ export interface Schema$UpgradeInstanceRequest {} + /** + * The Data Fusion version. + */ + export interface Schema$Version { + /** + * The version number of the Data Fusion instance, such as '6.0.1.0'. + */ + versionNumber?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -1044,6 +1079,7 @@ export namespace datafusion_v1beta1 { * @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. @@ -1339,7 +1375,7 @@ export namespace datafusion_v1beta1 { /** * datafusion.projects.locations.instances.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 datafusion.projects.locations.instances.setIamPolicy * @memberOf! () * @@ -1620,6 +1656,10 @@ export namespace datafusion_v1beta1 { */ 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. */ diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 6946d090b4a..1d5d283a093 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -412,7 +412,7 @@ export namespace dataproc_v1 { */ export interface Schema$ClusterStatus { /** - * Output only. Optional details of cluster's state. + * Optional. Output only. Details of cluster's state. */ detail?: string | null; /** @@ -618,7 +618,7 @@ export namespace dataproc_v1 { */ export interface Schema$InstanceGroupAutoscalingPolicyConfig { /** - * Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0. + * Required. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Secondary workers - Bounds: [min_instances, ). Default: 0. */ maxInstances?: number | null; /** @@ -793,7 +793,7 @@ export namespace dataproc_v1 { */ export interface Schema$JobStatus { /** - * Output only. Optional job state details, such as an error description if the state is <code>ERROR</code>. + * Optional. Output only. Job state details, such as an error description if the state is <code>ERROR</code>. */ details?: string | null; /** @@ -1129,19 +1129,19 @@ export namespace dataproc_v1 { scriptVariables?: {[key: string]: string} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). + * 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": "role/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). */ export interface Schema$Policy { /** - * Associates a list of members to a role. bindings with no members will result in an error. + * 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. */ 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. + * 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?: string | null; /** - * Specifies the format of the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -1227,7 +1227,7 @@ export namespace dataproc_v1 { */ imageVersion?: string | null; /** - * The set of optional components to activate on the cluster. + * Optional. The set of components to activate on the cluster. */ optionalComponents?: string[] | null; /** @@ -1470,9 +1470,6 @@ export namespace dataproc_v1 { * Output only. The time template was created. */ createTime?: string | null; - /** - * Required. The template id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. - */ id?: string | null; /** * Required. The Directed Acyclic Graph of Jobs to submit. @@ -1487,7 +1484,7 @@ export namespace dataproc_v1 { */ name?: string | null; /** - * Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. + * Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. */ parameters?: Schema$TemplateParameter[]; /** @@ -1512,7 +1509,7 @@ export namespace dataproc_v1 { */ clusterSelector?: Schema$ClusterSelector; /** - * Optional. A cluster that is managed by the workflow. + * A cluster that is managed by the workflow. */ managedCluster?: Schema$ManagedCluster; } @@ -5674,7 +5671,7 @@ export namespace dataproc_v1 { * @param {string} params.projectId Required. The ID of the Google Cloud Platform project the cluster belongs to. * @param {string} params.region Required. The Cloud Dataproc region in which to handle the request. * @param {string=} params.requestId Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. - * @param {string=} params.updateMask Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated:
              Mask Purpose
              labels Update labels
              config.worker_config.num_instances Resize primary worker group
              config.secondary_worker_config.num_instances Resize secondary worker group
              + * @param {string=} params.updateMask Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated:
              Mask Purpose
              labels Update labels
              config.worker_config.num_instances Resize primary worker group
              config.secondary_worker_config.num_instances Resize secondary worker group
              config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies
              * @param {().Cluster} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6171,7 +6168,7 @@ export namespace dataproc_v1 { */ requestId?: string; /** - * Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated:
              Mask Purpose
              labels Update labels
              config.worker_config.num_instances Resize primary worker group
              config.secondary_worker_config.num_instances Resize secondary worker group
              + * Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated:
              Mask Purpose
              labels Update labels
              config.worker_config.num_instances Resize primary worker group
              config.secondary_worker_config.num_instances Resize secondary worker group
              config.autoscaling_config.policy_uriUse, stop using, or change autoscaling policies
              */ updateMask?: string; diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index 6e283695968..4e8733bc6d1 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -458,7 +458,7 @@ export namespace dataproc_v1beta2 { */ bootDiskType?: string | null; /** - * Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries. + * Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries. */ numLocalSsds?: number | null; } @@ -652,7 +652,7 @@ export namespace dataproc_v1beta2 { 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 { /** @@ -684,7 +684,7 @@ export namespace dataproc_v1beta2 { */ managedGroupConfig?: Schema$ManagedGroupConfig; /** - * Optional. Specifies the minimum cpu platform for the Instance Group. See Cloud Dataproc&rarr;Minimum CPU Platform. + * Specifies the minimum cpu platform for the Instance Group. See Cloud Dataproc&rarr;Minimum CPU Platform. */ minCpuPlatform?: string | null; /** @@ -1170,19 +1170,19 @@ export namespace dataproc_v1beta2 { scriptVariables?: {[key: string]: string} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs). + * 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": "role/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). */ export interface Schema$Policy { /** - * Associates a list of members to a role. bindings with no members will result in an error. + * 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. */ 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. + * 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?: string | null; /** - * Specifies the format of the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -1327,7 +1327,7 @@ export namespace dataproc_v1beta2 { properties?: {[key: string]: string} | null; } /** - * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. + * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to CommonJob.jar_file_uris, and then specify the main class name in main_class. */ export interface Schema$SparkJob { /** @@ -1641,19 +1641,19 @@ export namespace dataproc_v1beta2 { */ export interface Schema$YarnApplication { /** - * Required. The application name. + * Output only. The application name. */ name?: string | null; /** - * Required. The numerical progress of the application, from 1 to 100. + * Output only. The numerical progress of the application, from 1 to 100. */ progress?: number | null; /** - * Required. The application state. + * Output only. The application state. */ state?: string | null; /** - * Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. + * Optional. Output only. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access. */ trackingUrl?: string | null; } @@ -4279,7 +4279,7 @@ export namespace dataproc_v1beta2 { /** * dataproc.projects.regions.clusters.diagnose - * @desc Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains DiagnoseClusterResults. + * @desc Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains Empty. * @alias dataproc.projects.regions.clusters.diagnose * @memberOf! () * diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index c4efbaa133a..8c7cbfee51a 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -1564,7 +1564,7 @@ export namespace datastore_v1 { /** * datastore.projects.reserveIds - * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. + * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. Used for imports only; other workloads are not supported. * @alias datastore.projects.reserveIds * @memberOf! () * @@ -1944,6 +1944,169 @@ export namespace datastore_v1 { this.context = context; } + /** + * datastore.projects.indexes.create + * @desc Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During index creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single property cannot be created. + * @alias datastore.projects.indexes.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.projectId Project ID against which to make the request. + * @param {().GoogleDatastoreAdminV1Index} params.resource Request body data + * @param {object} [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$Indexes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Indexes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Indexes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Indexes$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Indexes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Indexes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datastore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/projects/{projectId}/indexes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['projectId'], + pathParams: ['projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datastore.projects.indexes.delete + * @desc Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, followed by calling delete again. + * @alias datastore.projects.indexes.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.indexId The resource ID of the index to delete. + * @param {string} params.projectId Project ID against which to make the request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Indexes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Indexes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Indexes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Indexes$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Indexes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Indexes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datastore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/projects/{projectId}/indexes/{indexId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['projectId', 'indexId'], + pathParams: ['indexId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * datastore.projects.indexes.get * @desc Gets an index. @@ -2126,6 +2289,39 @@ export namespace datastore_v1 { } } + export interface Params$Resource$Projects$Indexes$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID against which to make the request. + */ + projectId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleDatastoreAdminV1Index; + } + export interface Params$Resource$Projects$Indexes$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource ID of the index to delete. + */ + indexId?: string; + /** + * Project ID against which to make the request. + */ + projectId?: string; + } export interface Params$Resource$Projects$Indexes$Get extends StandardParameters { /** diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index 8d1a53ae119..f825656c74a 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -1249,7 +1249,7 @@ export namespace datastore_v1beta3 { /** * datastore.projects.reserveIds - * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. + * @desc Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. Used for imports only; other workloads are not supported. * @alias datastore.projects.reserveIds * @memberOf! () * diff --git a/src/apis/dfareporting/index.ts b/src/apis/dfareporting/index.ts index 7574bf2d0eb..b11b7b26daf 100644 --- a/src/apis/dfareporting/index.ts +++ b/src/apis/dfareporting/index.ts @@ -14,42 +14,19 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {dfareporting_v3_1} from './v3.1'; -import {dfareporting_v3_2} from './v3.2'; import {dfareporting_v3_3} from './v3.3'; export const VERSIONS = { - 'v3.1': dfareporting_v3_1.Dfareporting, - 'v3.2': dfareporting_v3_2.Dfareporting, 'v3.3': dfareporting_v3_3.Dfareporting, }; -export function dfareporting(version: 'v3.1'): dfareporting_v3_1.Dfareporting; -export function dfareporting( - options: dfareporting_v3_1.Options -): dfareporting_v3_1.Dfareporting; -export function dfareporting(version: 'v3.2'): dfareporting_v3_2.Dfareporting; -export function dfareporting( - options: dfareporting_v3_2.Options -): dfareporting_v3_2.Dfareporting; export function dfareporting(version: 'v3.3'): dfareporting_v3_3.Dfareporting; export function dfareporting( options: dfareporting_v3_3.Options ): dfareporting_v3_3.Dfareporting; -export function dfareporting< - T = - | dfareporting_v3_1.Dfareporting - | dfareporting_v3_2.Dfareporting - | dfareporting_v3_3.Dfareporting ->( +export function dfareporting( this: GoogleConfigurable, - versionOrOptions: - | 'v3.1' - | dfareporting_v3_1.Options - | 'v3.2' - | dfareporting_v3_2.Options - | 'v3.3' - | dfareporting_v3_3.Options + versionOrOptions: 'v3.3' | dfareporting_v3_3.Options ) { return getAPI('dfareporting', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/dfareporting/v3.1.ts b/src/apis/dfareporting/v3.1.ts deleted file mode 100644 index eef485fc923..00000000000 --- a/src/apis/dfareporting/v3.1.ts +++ /dev/null @@ -1,37621 +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 dfareporting_v3_1 { - export interface Options extends GlobalOptions { - version: 'v3.1'; - } - - 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; - } - - /** - * DCM/DFA Reporting And Trafficking API - * - * Manages your DoubleClick Campaign Manager ad campaigns and reports. - * - * @example - * const {google} = require('googleapis'); - * const dfareporting = google.dfareporting('v3.1'); - * - * @namespace dfareporting - * @type {Function} - * @version v3.1 - * @variation v3.1 - * @param {object=} options Options for Dfareporting - */ - export class Dfareporting { - context: APIRequestContext; - accountActiveAdSummaries: Resource$Accountactiveadsummaries; - accountPermissionGroups: Resource$Accountpermissiongroups; - accountPermissions: Resource$Accountpermissions; - accounts: Resource$Accounts; - accountUserProfiles: Resource$Accountuserprofiles; - ads: Resource$Ads; - advertiserGroups: Resource$Advertisergroups; - advertiserLandingPages: Resource$Advertiserlandingpages; - advertisers: Resource$Advertisers; - browsers: Resource$Browsers; - campaignCreativeAssociations: Resource$Campaigncreativeassociations; - campaigns: Resource$Campaigns; - changeLogs: Resource$Changelogs; - cities: Resource$Cities; - connectionTypes: Resource$Connectiontypes; - contentCategories: Resource$Contentcategories; - conversions: Resource$Conversions; - countries: Resource$Countries; - creativeAssets: Resource$Creativeassets; - creativeFields: Resource$Creativefields; - creativeFieldValues: Resource$Creativefieldvalues; - creativeGroups: Resource$Creativegroups; - creatives: Resource$Creatives; - dimensionValues: Resource$Dimensionvalues; - directorySites: Resource$Directorysites; - dynamicTargetingKeys: Resource$Dynamictargetingkeys; - eventTags: Resource$Eventtags; - files: Resource$Files; - floodlightActivities: Resource$Floodlightactivities; - floodlightActivityGroups: Resource$Floodlightactivitygroups; - floodlightConfigurations: Resource$Floodlightconfigurations; - inventoryItems: Resource$Inventoryitems; - languages: Resource$Languages; - metros: Resource$Metros; - mobileApps: Resource$Mobileapps; - mobileCarriers: Resource$Mobilecarriers; - operatingSystems: Resource$Operatingsystems; - operatingSystemVersions: Resource$Operatingsystemversions; - orderDocuments: Resource$Orderdocuments; - orders: Resource$Orders; - placementGroups: Resource$Placementgroups; - placements: Resource$Placements; - placementStrategies: Resource$Placementstrategies; - platformTypes: Resource$Platformtypes; - postalCodes: Resource$Postalcodes; - projects: Resource$Projects; - regions: Resource$Regions; - remarketingLists: Resource$Remarketinglists; - remarketingListShares: Resource$Remarketinglistshares; - reports: Resource$Reports; - sites: Resource$Sites; - sizes: Resource$Sizes; - subaccounts: Resource$Subaccounts; - targetableRemarketingLists: Resource$Targetableremarketinglists; - targetingTemplates: Resource$Targetingtemplates; - userProfiles: Resource$Userprofiles; - userRolePermissionGroups: Resource$Userrolepermissiongroups; - userRolePermissions: Resource$Userrolepermissions; - userRoles: Resource$Userroles; - videoFormats: Resource$Videoformats; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.accountActiveAdSummaries = new Resource$Accountactiveadsummaries( - this.context - ); - this.accountPermissionGroups = new Resource$Accountpermissiongroups( - this.context - ); - this.accountPermissions = new Resource$Accountpermissions(this.context); - this.accounts = new Resource$Accounts(this.context); - this.accountUserProfiles = new Resource$Accountuserprofiles(this.context); - this.ads = new Resource$Ads(this.context); - this.advertiserGroups = new Resource$Advertisergroups(this.context); - this.advertiserLandingPages = new Resource$Advertiserlandingpages( - this.context - ); - this.advertisers = new Resource$Advertisers(this.context); - this.browsers = new Resource$Browsers(this.context); - this.campaignCreativeAssociations = new Resource$Campaigncreativeassociations( - this.context - ); - this.campaigns = new Resource$Campaigns(this.context); - this.changeLogs = new Resource$Changelogs(this.context); - this.cities = new Resource$Cities(this.context); - this.connectionTypes = new Resource$Connectiontypes(this.context); - this.contentCategories = new Resource$Contentcategories(this.context); - this.conversions = new Resource$Conversions(this.context); - this.countries = new Resource$Countries(this.context); - this.creativeAssets = new Resource$Creativeassets(this.context); - this.creativeFields = new Resource$Creativefields(this.context); - this.creativeFieldValues = new Resource$Creativefieldvalues(this.context); - this.creativeGroups = new Resource$Creativegroups(this.context); - this.creatives = new Resource$Creatives(this.context); - this.dimensionValues = new Resource$Dimensionvalues(this.context); - this.directorySites = new Resource$Directorysites(this.context); - this.dynamicTargetingKeys = new Resource$Dynamictargetingkeys( - this.context - ); - this.eventTags = new Resource$Eventtags(this.context); - this.files = new Resource$Files(this.context); - this.floodlightActivities = new Resource$Floodlightactivities( - this.context - ); - this.floodlightActivityGroups = new Resource$Floodlightactivitygroups( - this.context - ); - this.floodlightConfigurations = new Resource$Floodlightconfigurations( - this.context - ); - this.inventoryItems = new Resource$Inventoryitems(this.context); - this.languages = new Resource$Languages(this.context); - this.metros = new Resource$Metros(this.context); - this.mobileApps = new Resource$Mobileapps(this.context); - this.mobileCarriers = new Resource$Mobilecarriers(this.context); - this.operatingSystems = new Resource$Operatingsystems(this.context); - this.operatingSystemVersions = new Resource$Operatingsystemversions( - this.context - ); - this.orderDocuments = new Resource$Orderdocuments(this.context); - this.orders = new Resource$Orders(this.context); - this.placementGroups = new Resource$Placementgroups(this.context); - this.placements = new Resource$Placements(this.context); - this.placementStrategies = new Resource$Placementstrategies(this.context); - this.platformTypes = new Resource$Platformtypes(this.context); - this.postalCodes = new Resource$Postalcodes(this.context); - this.projects = new Resource$Projects(this.context); - this.regions = new Resource$Regions(this.context); - this.remarketingLists = new Resource$Remarketinglists(this.context); - this.remarketingListShares = new Resource$Remarketinglistshares( - this.context - ); - this.reports = new Resource$Reports(this.context); - this.sites = new Resource$Sites(this.context); - this.sizes = new Resource$Sizes(this.context); - this.subaccounts = new Resource$Subaccounts(this.context); - this.targetableRemarketingLists = new Resource$Targetableremarketinglists( - this.context - ); - this.targetingTemplates = new Resource$Targetingtemplates(this.context); - this.userProfiles = new Resource$Userprofiles(this.context); - this.userRolePermissionGroups = new Resource$Userrolepermissiongroups( - this.context - ); - this.userRolePermissions = new Resource$Userrolepermissions(this.context); - this.userRoles = new Resource$Userroles(this.context); - this.videoFormats = new Resource$Videoformats(this.context); - } - } - - /** - * Contains properties of a Campaign Manager account. - */ - export interface Schema$Account { - /** - * Account permissions assigned to this account. - */ - accountPermissionIds?: string[] | null; - /** - * Profile for this account. This is a read-only field that can be left blank. - */ - accountProfile?: string | null; - /** - * Whether this account is active. - */ - active?: boolean | null; - /** - * Maximum number of active ads allowed for this account. - */ - activeAdsLimitTier?: string | null; - /** - * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. - */ - activeViewOptOut?: boolean | null; - /** - * User role permissions available to the user roles of this account. - */ - availablePermissionIds?: string[] | null; - /** - * ID of the country associated with this account. - */ - countryId?: string | null; - /** - * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - */ - currencyId?: string | null; - /** - * Default placement dimensions for this account. - */ - defaultCreativeSizeId?: string | null; - /** - * Description of this account. - */ - description?: string | null; - /** - * ID of this account. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". - */ - kind?: string | null; - /** - * Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) - */ - locale?: string | null; - /** - * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. - */ - maximumImageSize?: string | null; - /** - * Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. - */ - name?: string | null; - /** - * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. - */ - nielsenOcrEnabled?: boolean | null; - /** - * Reporting configuration of this account. - */ - reportsConfiguration?: Schema$ReportsConfiguration; - /** - * Share Path to Conversion reports with Twitter. - */ - shareReportsWithTwitter?: boolean | null; - /** - * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. - */ - teaserSizeLimit?: string | null; - } - /** - * Gets a summary of active ads in an account. - */ - export interface Schema$AccountActiveAdSummary { - /** - * ID of the account. - */ - accountId?: string | null; - /** - * Ads that have been activated for the account - */ - activeAds?: string | null; - /** - * Maximum number of active ads allowed for the account. - */ - activeAdsLimitTier?: string | null; - /** - * Ads that can be activated for the account. - */ - availableAds?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". - */ - kind?: string | null; - } - /** - * AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account. - */ - export interface Schema$AccountPermission { - /** - * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" - */ - accountProfiles?: string[] | null; - /** - * ID of this account permission. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". - */ - kind?: string | null; - /** - * Administrative level required to enable this account permission. - */ - level?: string | null; - /** - * Name of this account permission. - */ - name?: string | null; - /** - * Permission group of this account permission. - */ - permissionGroupId?: string | null; - } - /** - * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. - */ - export interface Schema$AccountPermissionGroup { - /** - * ID of this account permission group. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". - */ - kind?: string | null; - /** - * Name of this account permission group. - */ - name?: string | null; - } - /** - * Account Permission Group List Response - */ - export interface Schema$AccountPermissionGroupsListResponse { - /** - * Account permission group collection. - */ - accountPermissionGroups?: Schema$AccountPermissionGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". - */ - kind?: string | null; - } - /** - * Account Permission List Response - */ - export interface Schema$AccountPermissionsListResponse { - /** - * Account permission collection. - */ - accountPermissions?: Schema$AccountPermission[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". - */ - kind?: string | null; - } - /** - * Account List Response - */ - export interface Schema$AccountsListResponse { - /** - * Account collection. - */ - accounts?: Schema$Account[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API. - */ - export interface Schema$AccountUserProfile { - /** - * Account ID of the user profile. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. - */ - active?: boolean | null; - /** - * Filter that describes which advertisers are visible to the user profile. - */ - advertiserFilter?: Schema$ObjectFilter; - /** - * Filter that describes which campaigns are visible to the user profile. - */ - campaignFilter?: Schema$ObjectFilter; - /** - * Comments for this user profile. - */ - comments?: string | null; - /** - * Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion. - */ - email?: string | null; - /** - * ID of the user profile. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". - */ - kind?: string | null; - /** - * Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) - */ - locale?: string | null; - /** - * Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,". - */ - name?: string | null; - /** - * Filter that describes which sites are visible to the user profile. - */ - siteFilter?: Schema$ObjectFilter; - /** - * Subaccount ID of the user profile. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Trafficker type of this user profile. This is a read-only field. - */ - traffickerType?: string | null; - /** - * User type of the user profile. This is a read-only field that can be left blank. - */ - userAccessType?: string | null; - /** - * Filter that describes which user roles are visible to the user profile. - */ - userRoleFilter?: Schema$ObjectFilter; - /** - * User role ID of the user profile. This is a required field. - */ - userRoleId?: string | null; - } - /** - * Account User Profile List Response - */ - export interface Schema$AccountUserProfilesListResponse { - /** - * Account user profile collection. - */ - accountUserProfiles?: Schema$AccountUserProfile[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Represents an activity group. - */ - export interface Schema$Activities { - /** - * List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". - */ - filters?: Schema$DimensionValue[]; - /** - * The kind of resource this is, in this case dfareporting#activities. - */ - kind?: string | null; - /** - * List of names of floodlight activity metrics. - */ - metricNames?: string[] | null; - } - /** - * Contains properties of a Campaign Manager ad. - */ - export interface Schema$Ad { - /** - * Account ID of this ad. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Whether this ad is active. When true, archived must be false. - */ - active?: boolean | null; - /** - * Advertiser ID of this ad. This is a required field on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this ad is archived. When true, active must be false. - */ - archived?: boolean | null; - /** - * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. - */ - audienceSegmentId?: string | null; - /** - * Campaign ID of this ad. This is a required field on insertion. - */ - campaignId?: string | null; - /** - * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative. - */ - clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; - /** - * Comments for this ad. - */ - comments?: string | null; - /** - * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. - */ - compatibility?: string | null; - /** - * Information about the creation of this ad. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments. - */ - creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; - /** - * Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment. - */ - creativeRotation?: Schema$CreativeRotation; - /** - * Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - dayPartTargeting?: Schema$DayPartTargeting; - /** - * Default click-through event tag properties for this ad. - */ - defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; - /** - * Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD. - */ - deliverySchedule?: Schema$DeliverySchedule; - /** - * Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert. - */ - dynamicClickTracker?: boolean | null; - /** - * Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. - */ - endTime?: string | null; - /** - * Event tag overrides for this ad. - */ - eventTagOverrides?: Schema$EventTagOverride[]; - /** - * Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - geoTargeting?: Schema$GeoTargeting; - /** - * ID of this ad. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this ad. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". - */ - kind?: string | null; - /** - * Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - languageTargeting?: Schema$LanguageTargeting; - /** - * Information about the most recent modification of this ad. This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this ad. This is a required field and must be less than 256 characters long. - */ - name?: string | null; - /** - * Placement assignments for this ad. - */ - placementAssignments?: Schema$PlacementAssignment[]; - /** - * Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - remarketingListExpression?: Schema$ListTargetingExpression; - /** - * Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. - */ - size?: Schema$Size; - /** - * Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. - */ - sslCompliant?: boolean | null; - /** - * Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. - */ - sslRequired?: boolean | null; - /** - * Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion. - */ - startTime?: string | null; - /** - * Subaccount ID of this ad. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. - */ - targetingTemplateId?: string | null; - /** - * Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - technologyTargeting?: Schema$TechnologyTargeting; - /** - * Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). - */ - type?: string | null; - } - /** - * Campaign ad blocking settings. - */ - export interface Schema$AdBlockingConfiguration { - /** - * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. - */ - clickThroughUrl?: string | null; - /** - * ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. - */ - creativeBundleId?: string | null; - /** - * Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. - */ - enabled?: boolean | null; - /** - * Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. - */ - overrideClickThroughUrl?: boolean | null; - } - /** - * Ad List Response - */ - export interface Schema$AdsListResponse { - /** - * Ad collection. - */ - ads?: Schema$Ad[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Ad Slot - */ - export interface Schema$AdSlot { - /** - * Comment for this ad slot. - */ - comment?: string | null; - /** - * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. - */ - compatibility?: string | null; - /** - * Height of this ad slot. - */ - height?: string | null; - /** - * ID of the placement from an external platform that is linked to this ad slot. - */ - linkedPlacementId?: string | null; - /** - * Name of this ad slot. - */ - name?: string | null; - /** - * Payment source type of this ad slot. - */ - paymentSourceType?: string | null; - /** - * Primary ad slot of a roadblock inventory item. - */ - primary?: boolean | null; - /** - * Width of this ad slot. - */ - width?: string | null; - } - /** - * Contains properties of a Campaign Manager advertiser. - */ - export interface Schema$Advertiser { - /** - * Account ID of this advertiser.This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. - */ - advertiserGroupId?: string | null; - /** - * Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. - */ - clickThroughUrlSuffix?: string | null; - /** - * ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. - */ - defaultClickThroughEventTagId?: string | null; - /** - * Default email address used in sender field for tag emails. - */ - defaultEmail?: string | null; - /** - * Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. - */ - floodlightConfigurationId?: string | null; - /** - * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this advertiser. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". - */ - kind?: string | null; - /** - * Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. - */ - name?: string | null; - /** - * Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. - */ - originalFloodlightConfigurationId?: string | null; - /** - * Status of this advertiser. - */ - status?: string | null; - /** - * Subaccount ID of this advertiser.This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Suspension status of this advertiser. - */ - suspended?: boolean | null; - } - /** - * Groups advertisers together so that reports can be generated for the entire group at once. - */ - export interface Schema$AdvertiserGroup { - /** - * Account ID of this advertiser group. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * ID of this advertiser group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". - */ - kind?: string | null; - /** - * Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. - */ - name?: string | null; - } - /** - * Advertiser Group List Response - */ - export interface Schema$AdvertiserGroupsListResponse { - /** - * Advertiser group collection. - */ - advertiserGroups?: Schema$AdvertiserGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Landing Page List Response - */ - export interface Schema$AdvertiserLandingPagesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". - */ - kind?: string | null; - /** - * Landing page collection - */ - landingPages?: Schema$LandingPage[]; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Advertiser List Response - */ - export interface Schema$AdvertisersListResponse { - /** - * Advertiser collection. - */ - advertisers?: Schema$Advertiser[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Audience Segment. - */ - export interface Schema$AudienceSegment { - /** - * Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. - */ - allocation?: number | null; - /** - * ID of this audience segment. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Name of this audience segment. This is a required field and must be less than 65 characters long. - */ - name?: string | null; - } - /** - * Audience Segment Group. - */ - export interface Schema$AudienceSegmentGroup { - /** - * Audience segments assigned to this group. The number of segments must be between 2 and 100. - */ - audienceSegments?: Schema$AudienceSegment[]; - /** - * ID of this audience segment group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Name of this audience segment group. This is a required field and must be less than 65 characters long. - */ - name?: string | null; - } - /** - * Contains information about a browser that can be targeted by ads. - */ - export interface Schema$Browser { - /** - * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. - */ - browserVersionId?: string | null; - /** - * DART ID of this browser. This is the ID used when generating reports. - */ - dartId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". - */ - kind?: string | null; - /** - * Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. - */ - majorVersion?: string | null; - /** - * Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. - */ - minorVersion?: string | null; - /** - * Name of this browser. - */ - name?: string | null; - } - /** - * Browser List Response - */ - export interface Schema$BrowsersListResponse { - /** - * Browser collection. - */ - browsers?: Schema$Browser[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". - */ - kind?: string | null; - } - /** - * Contains properties of a Campaign Manager campaign. - */ - export interface Schema$Campaign { - /** - * Account ID of this campaign. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Ad blocking settings for this campaign. - */ - adBlockingConfiguration?: Schema$AdBlockingConfiguration; - /** - * Additional creative optimization configurations for the campaign. - */ - additionalCreativeOptimizationConfigurations?: Schema$CreativeOptimizationConfiguration[]; - /** - * Advertiser group ID of the associated advertiser. - */ - advertiserGroupId?: string | null; - /** - * Advertiser ID of this campaign. This is a required field. - */ - advertiserId?: string | null; - /** - * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this campaign has been archived. - */ - archived?: boolean | null; - /** - * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. - */ - audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; - /** - * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. - */ - billingInvoiceCode?: string | null; - /** - * Click-through URL suffix override properties for this campaign. - */ - clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; - /** - * Arbitrary comments about this campaign. Must be less than 256 characters long. - */ - comment?: string | null; - /** - * Information about the creation of this campaign. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * List of creative group IDs that are assigned to the campaign. - */ - creativeGroupIds?: string[] | null; - /** - * Creative optimization configuration for the campaign. - */ - creativeOptimizationConfiguration?: Schema$CreativeOptimizationConfiguration; - /** - * Click-through event tag ID override properties for this campaign. - */ - defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; - /** - * The default landing page ID for this campaign. - */ - defaultLandingPageId?: string | null; - /** - * Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field. - */ - endDate?: string | null; - /** - * Overrides that can be used to activate or deactivate advertiser event tags. - */ - eventTagOverrides?: Schema$EventTagOverride[]; - /** - * External ID for this campaign. - */ - externalId?: string | null; - /** - * ID of this campaign. This is a read-only auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". - */ - kind?: string | null; - /** - * Information about the most recent modification of this campaign. This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. - */ - name?: string | null; - /** - * Whether Nielsen reports are enabled for this campaign. - */ - nielsenOcrEnabled?: boolean | null; - /** - * Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field. - */ - startDate?: string | null; - /** - * Subaccount ID of this campaign. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Campaign trafficker contact emails. - */ - traffickerEmails?: string[] | null; - } - /** - * Identifies a creative which has been associated with a given campaign. - */ - export interface Schema$CampaignCreativeAssociation { - /** - * ID of the creative associated with the campaign. This is a required field. - */ - creativeId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". - */ - kind?: string | null; - } - /** - * Campaign Creative Association List Response - */ - export interface Schema$CampaignCreativeAssociationsListResponse { - /** - * Campaign creative association collection - */ - campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Campaign List Response - */ - export interface Schema$CampaignsListResponse { - /** - * Campaign collection. - */ - campaigns?: Schema$Campaign[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Describes a change that a user has made to a resource. - */ - export interface Schema$ChangeLog { - /** - * Account ID of the modified object. - */ - accountId?: string | null; - /** - * Action which caused the change. - */ - action?: string | null; - /** - * Time when the object was modified. - */ - changeTime?: string | null; - /** - * Field name of the object which changed. - */ - fieldName?: string | null; - /** - * ID of this change log. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". - */ - kind?: string | null; - /** - * New value of the object field. - */ - newValue?: string | null; - /** - * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. - */ - objectId?: string | null; - /** - * Object type of the change log. - */ - objectType?: string | null; - /** - * Old value of the object field. - */ - oldValue?: string | null; - /** - * Subaccount ID of the modified object. - */ - subaccountId?: string | null; - /** - * Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. - */ - transactionId?: string | null; - /** - * ID of the user who modified the object. - */ - userProfileId?: string | null; - /** - * User profile name of the user who modified the object. - */ - userProfileName?: string | null; - } - /** - * Change Log List Response - */ - export interface Schema$ChangeLogsListResponse { - /** - * Change log collection. - */ - changeLogs?: Schema$ChangeLog[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * City List Response - */ - export interface Schema$CitiesListResponse { - /** - * City collection. - */ - cities?: Schema$City[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". - */ - kind?: string | null; - } - /** - * Contains information about a city that can be targeted by ads. - */ - export interface Schema$City { - /** - * Country code of the country to which this city belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this city belongs. - */ - countryDartId?: string | null; - /** - * DART ID of this city. This is the ID used for targeting and generating reports. - */ - dartId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". - */ - kind?: string | null; - /** - * Metro region code of the metro region (DMA) to which this city belongs. - */ - metroCode?: string | null; - /** - * ID of the metro region (DMA) to which this city belongs. - */ - metroDmaId?: string | null; - /** - * Name of this city. - */ - name?: string | null; - /** - * Region code of the region to which this city belongs. - */ - regionCode?: string | null; - /** - * DART ID of the region to which this city belongs. - */ - regionDartId?: string | null; - } - /** - * Creative Click Tag. - */ - export interface Schema$ClickTag { - /** - * Parameter value for the specified click tag. This field contains a click-through url. - */ - clickThroughUrl?: Schema$CreativeClickThroughUrl; - /** - * Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - eventName?: string | null; - /** - * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field. - */ - name?: string | null; - } - /** - * Click-through URL - */ - export interface Schema$ClickThroughUrl { - /** - * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. - */ - computedClickThroughUrl?: string | null; - /** - * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. - */ - customClickThroughUrl?: string | null; - /** - * Whether the campaign default landing page is used. - */ - defaultLandingPage?: boolean | null; - /** - * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. - */ - landingPageId?: string | null; - } - /** - * Click Through URL Suffix settings. - */ - export interface Schema$ClickThroughUrlSuffixProperties { - /** - * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. - */ - clickThroughUrlSuffix?: string | null; - /** - * Whether this entity should override the inherited click-through URL suffix with its own defined value. - */ - overrideInheritedSuffix?: boolean | null; - } - /** - * Companion Click-through override. - */ - export interface Schema$CompanionClickThroughOverride { - /** - * Click-through URL of this companion click-through override. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * ID of the creative for this companion click-through override. - */ - creativeId?: string | null; - } - /** - * Companion Settings - */ - export interface Schema$CompanionSetting { - /** - * Whether companions are disabled for this placement. - */ - companionsDisabled?: boolean | null; - /** - * Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. - */ - enabledSizes?: Schema$Size[]; - /** - * Whether to serve only static images as companions. - */ - imageOnly?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". - */ - kind?: string | null; - } - /** - * Represents a response to the queryCompatibleFields method. - */ - export interface Schema$CompatibleFields { - /** - * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". - */ - crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". - */ - floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; - /** - * The kind of resource this is, in this case dfareporting#compatibleFields. - */ - kind?: string | null; - /** - * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". - */ - pathToConversionReportCompatibleFields?: Schema$PathToConversionReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type "REACH". - */ - reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type "STANDARD". - */ - reportCompatibleFields?: Schema$ReportCompatibleFields; - } - /** - * Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. - */ - export interface Schema$ConnectionType { - /** - * ID of this connection type. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". - */ - kind?: string | null; - /** - * Name of this connection type. - */ - name?: string | null; - } - /** - * Connection Type List Response - */ - export interface Schema$ConnectionTypesListResponse { - /** - * Collection of connection types such as broadband and mobile. - */ - connectionTypes?: Schema$ConnectionType[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". - */ - kind?: string | null; - } - /** - * Content Category List Response - */ - export interface Schema$ContentCategoriesListResponse { - /** - * Content category collection. - */ - contentCategories?: Schema$ContentCategory[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Organizes placements according to the contents of their associated webpages. - */ - export interface Schema$ContentCategory { - /** - * Account ID of this content category. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * ID of this content category. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". - */ - kind?: string | null; - /** - * Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account. - */ - name?: string | null; - } - /** - * A Conversion represents when a user successfully performs a desired action after seeing an ad. - */ - export interface Schema$Conversion { - /** - * Whether this particular request may come from a user under the age of 13, under COPPA compliance. - */ - childDirectedTreatment?: boolean | null; - /** - * Custom floodlight variables. - */ - customVariables?: Schema$CustomFloodlightVariable[]; - /** - * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. - */ - encryptedUserId?: string | null; - /** - * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field. - */ - encryptedUserIdCandidates?: string[] | null; - /** - * Floodlight Activity ID of this conversion. This is a required field. - */ - floodlightActivityId?: string | null; - /** - * Floodlight Configuration ID of this conversion. This is a required field. - */ - floodlightConfigurationId?: string | null; - /** - * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field. - */ - gclid?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". - */ - kind?: string | null; - /** - * Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. - */ - limitAdTracking?: boolean | null; - /** - * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field. - */ - mobileDeviceId?: string | null; - /** - * Whether the conversion was for a non personalized ad. - */ - nonPersonalizedAd?: boolean | null; - /** - * The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. - */ - ordinal?: string | null; - /** - * The quantity of the conversion. - */ - quantity?: string | null; - /** - * The timestamp of conversion, in Unix epoch micros. This is a required field. - */ - timestampMicros?: string | null; - /** - * Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). - */ - treatmentForUnderage?: boolean | null; - /** - * The value of the conversion. - */ - value?: number | null; - } - /** - * The error code and description for a conversion that failed to insert or update. - */ - export interface Schema$ConversionError { - /** - * The error code. - */ - code?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". - */ - kind?: string | null; - /** - * A description of the error. - */ - message?: string | null; - } - /** - * Insert Conversions Request. - */ - export interface Schema$ConversionsBatchInsertRequest { - /** - * The set of conversions to insert. - */ - conversions?: Schema$Conversion[]; - /** - * Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used. - */ - encryptionInfo?: Schema$EncryptionInfo; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". - */ - kind?: string | null; - } - /** - * Insert Conversions Response. - */ - export interface Schema$ConversionsBatchInsertResponse { - /** - * Indicates that some or all conversions failed to insert. - */ - hasFailures?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". - */ - kind?: string | null; - /** - * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. - */ - status?: Schema$ConversionStatus[]; - } - /** - * Update Conversions Request. - */ - export interface Schema$ConversionsBatchUpdateRequest { - /** - * The set of conversions to update. - */ - conversions?: Schema$Conversion[]; - /** - * Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used. - */ - encryptionInfo?: Schema$EncryptionInfo; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". - */ - kind?: string | null; - } - /** - * Update Conversions Response. - */ - export interface Schema$ConversionsBatchUpdateResponse { - /** - * Indicates that some or all conversions failed to update. - */ - hasFailures?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". - */ - kind?: string | null; - /** - * The update status of each conversion. Statuses are returned in the same order that conversions are updated. - */ - status?: Schema$ConversionStatus[]; - } - /** - * The original conversion that was inserted or updated and whether there were any errors. - */ - export interface Schema$ConversionStatus { - /** - * The original conversion that was inserted or updated. - */ - conversion?: Schema$Conversion; - /** - * A list of errors related to this conversion. - */ - errors?: Schema$ConversionError[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". - */ - kind?: string | null; - } - /** - * Country List Response - */ - export interface Schema$CountriesListResponse { - /** - * Country collection. - */ - countries?: Schema$Country[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". - */ - kind?: string | null; - } - /** - * Contains information about a country that can be targeted by ads. - */ - export interface Schema$Country { - /** - * Country code. - */ - countryCode?: string | null; - /** - * DART ID of this country. This is the ID used for targeting and generating reports. - */ - dartId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". - */ - kind?: string | null; - /** - * Name of this country. - */ - name?: string | null; - /** - * Whether ad serving supports secure servers in this country. - */ - sslEnabled?: boolean | null; - } - /** - * Contains properties of a Creative. - */ - export interface Schema$Creative { - /** - * Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. - */ - accountId?: string | null; - /** - * Whether the creative is active. Applicable to all creative types. - */ - active?: boolean | null; - /** - * Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE. - */ - additionalSizes?: Schema$Size[]; - /** - * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. - */ - adParameters?: string | null; - /** - * Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - adTagKeys?: string[] | null; - /** - * Advertiser ID of this creative. This is a required field. Applicable to all creative types. - */ - advertiserId?: string | null; - /** - * Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. - */ - allowScriptAccess?: boolean | null; - /** - * Whether the creative is archived. Applicable to all creative types. - */ - archived?: boolean | null; - /** - * Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - artworkType?: string | null; - /** - * Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. - */ - authoringSource?: string | null; - /** - * Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - */ - authoringTool?: string | null; - /** - * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. - */ - autoAdvanceImages?: boolean | null; - /** - * The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. - */ - backgroundColor?: string | null; - /** - * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. - */ - backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl; - /** - * List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - backupImageFeatures?: string[] | null; - /** - * Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. - */ - backupImageReportingLabel?: string | null; - /** - * Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - backupImageTargetWindow?: Schema$TargetWindow; - /** - * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - clickTags?: Schema$ClickTag[]; - /** - * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. - */ - commercialId?: string | null; - /** - * List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. - */ - companionCreatives?: string[] | null; - /** - * Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" - */ - compatibility?: string[] | null; - /** - * Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - convertFlashToHtml5?: boolean | null; - /** - * List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. - */ - counterCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT - */ - creativeAssets?: Schema$CreativeAsset[]; - /** - * Required if dynamicAssetSelection is true. - */ - creativeAssetSelection?: Schema$CreativeAssetSelection; - /** - * Creative field assignments for this creative. Applicable to all creative types. - */ - creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; - /** - * Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - customKeyValues?: string[] | null; - /** - * Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives. - */ - dynamicAssetSelection?: boolean | null; - /** - * List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - exitCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE. - */ - fsCommand?: Schema$FsCommand; - /** - * HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. - */ - htmlCode?: string | null; - /** - * Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. - */ - htmlCodeLocked?: boolean | null; - /** - * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. - */ - id?: string | null; - /** - * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". - */ - kind?: string | null; - /** - * Creative last modification information. This is a read-only field. Applicable to all creative types. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - latestTraffickedCreativeId?: string | null; - /** - * Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. - */ - mediaDescription?: string | null; - /** - * Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. - */ - mediaDuration?: number | null; - /** - * Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types. - */ - name?: string | null; - /** - * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. - */ - overrideCss?: string | null; - /** - * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. - */ - progressOffset?: Schema$VideoOffset; - /** - * URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT - */ - redirectUrl?: string | null; - /** - * ID of current rendering version. This is a read-only field. Applicable to all creative types. - */ - renderingId?: string | null; - /** - * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. - */ - renderingIdDimensionValue?: Schema$DimensionValue; - /** - * The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - requiredFlashPluginVersion?: string | null; - /** - * The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - requiredFlashVersion?: number | null; - /** - * Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. - */ - size?: Schema$Size; - /** - * Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO. - */ - skipOffset?: Schema$VideoOffset; - /** - * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. - */ - skippable?: boolean | null; - /** - * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. - */ - sslCompliant?: boolean | null; - /** - * Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. - */ - sslOverride?: boolean | null; - /** - * Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - studioAdvertiserId?: string | null; - /** - * Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - studioCreativeId?: string | null; - /** - * Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - studioTraffickedCreativeId?: string | null; - /** - * Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. - */ - subaccountId?: string | null; - /** - * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. - */ - thirdPartyBackupImageImpressionsUrl?: string | null; - /** - * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. - */ - thirdPartyRichMediaImpressionsUrl?: string | null; - /** - * Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. - */ - thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; - /** - * List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. - */ - timerCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - totalFileSize?: string | null; - /** - * Type of this creative. This is a required field. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. - */ - type?: string | null; - /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. - */ - universalAdId?: Schema$UniversalAdId; - /** - * The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. - */ - version?: number | null; - } - /** - * Creative Asset. - */ - export interface Schema$CreativeAsset { - /** - * Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - actionScript3?: boolean | null; - /** - * Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - */ - active?: boolean | null; - /** - * Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render. - */ - additionalSizes?: Schema$Size[]; - /** - * Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. - */ - alignment?: string | null; - /** - * Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - artworkType?: string | null; - /** - * Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - assetIdentifier?: Schema$CreativeAssetId; - /** - * Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA. - */ - backupImageExit?: Schema$CreativeCustomEvent; - /** - * Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - */ - bitRate?: number | null; - /** - * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. - */ - childAssetType?: string | null; - /** - * Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. - */ - collapsedSize?: Schema$Size; - /** - * List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true. - */ - companionCreativeIds?: string[] | null; - /** - * Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0. - */ - customStartTimeValue?: number | null; - /** - * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - detectedFeatures?: string[] | null; - /** - * Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - displayType?: string | null; - /** - * Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. - */ - duration?: number | null; - /** - * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. - */ - durationType?: string | null; - /** - * Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - expandedDimension?: Schema$Size; - /** - * File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - fileSize?: string | null; - /** - * Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - flashVersion?: number | null; - /** - * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. - */ - hideFlashObjects?: boolean | null; - /** - * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. - */ - hideSelectionBoxes?: boolean | null; - /** - * Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - horizontallyLocked?: boolean | null; - /** - * Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - id?: string | null; - /** - * Dimension value for the ID of the asset. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - */ - mediaDuration?: number | null; - /** - * Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - */ - mimeType?: string | null; - /** - * Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. - */ - offset?: Schema$OffsetPosition; - /** - * Orientation of video asset. This is a read-only, auto-generated field. - */ - orientation?: string | null; - /** - * Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA. - */ - originalBackup?: boolean | null; - /** - * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. - */ - position?: Schema$OffsetPosition; - /** - * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - positionLeftUnit?: string | null; - /** - * Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA. - */ - positionTopUnit?: string | null; - /** - * Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - progressiveServingUrl?: string | null; - /** - * Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. - */ - pushdown?: boolean | null; - /** - * Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive. - */ - pushdownDuration?: number | null; - /** - * Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. - */ - role?: string | null; - /** - * Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - size?: Schema$Size; - /** - * Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - sslCompliant?: boolean | null; - /** - * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. - */ - startTimeType?: string | null; - /** - * Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - streamingServingUrl?: string | null; - /** - * Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. - */ - transparency?: boolean | null; - /** - * Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - verticallyLocked?: boolean | null; - /** - * Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. - */ - windowMode?: string | null; - /** - * zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive. - */ - zIndex?: number | null; - /** - * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - */ - zipFilename?: string | null; - /** - * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - */ - zipFilesize?: string | null; - } - /** - * Creative Asset ID. - */ - export interface Schema$CreativeAssetId { - /** - * Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed. - */ - name?: string | null; - /** - * Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE. - */ - type?: string | null; - } - /** - * CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative. - */ - export interface Schema$CreativeAssetMetadata { - /** - * ID of the creative asset. This is a required field. - */ - assetIdentifier?: Schema$CreativeAssetId; - /** - * List of detected click tags for assets. This is a read-only auto-generated field. - */ - clickTags?: Schema$ClickTag[]; - /** - * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. - */ - detectedFeatures?: string[] | null; - /** - * Numeric ID of the asset. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". - */ - kind?: string | null; - /** - * Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID" - */ - warnedValidationRules?: string[] | null; - } - /** - * Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. - */ - export interface Schema$CreativeAssetSelection { - /** - * A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field. - */ - defaultAssetId?: string | null; - /** - * Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. - */ - rules?: Schema$Rule[]; - } - /** - * Creative Assignment. - */ - export interface Schema$CreativeAssignment { - /** - * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. - */ - active?: boolean | null; - /** - * Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. - */ - applyEventTags?: boolean | null; - /** - * Click-through URL of the creative assignment. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Companion creative overrides for this creative assignment. Applicable to video ads. - */ - companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; - /** - * Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. - */ - creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; - /** - * ID of the creative to be assigned. This is a required field. - */ - creativeId?: string | null; - /** - * Dimension value for the ID of the creative. This is a read-only, auto-generated field. - */ - creativeIdDimensionValue?: Schema$DimensionValue; - /** - * Date and time that the assigned creative should stop serving. Must be later than the start time. - */ - endTime?: string | null; - /** - * Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR - */ - richMediaExitOverrides?: Schema$RichMediaExitOverride[]; - /** - * Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. - */ - sequence?: number | null; - /** - * Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. - */ - sslCompliant?: boolean | null; - /** - * Date and time that the assigned creative should start serving. - */ - startTime?: string | null; - /** - * Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. - */ - weight?: number | null; - } - /** - * Click-through URL - */ - export interface Schema$CreativeClickThroughUrl { - /** - * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. - */ - computedClickThroughUrl?: string | null; - /** - * Custom click-through URL. Applicable if the landingPageId field is left unset. - */ - customClickThroughUrl?: string | null; - /** - * ID of the landing page for the click-through URL. - */ - landingPageId?: string | null; - } - /** - * Creative Custom Event. - */ - export interface Schema$CreativeCustomEvent { - /** - * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. - */ - advertiserCustomEventId?: string | null; - /** - * User-entered name for the event. - */ - advertiserCustomEventName?: string | null; - /** - * Type of the event. This is a read-only field. - */ - advertiserCustomEventType?: string | null; - /** - * Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. - */ - artworkLabel?: string | null; - /** - * Artwork type used by the creative.This is a read-only field. - */ - artworkType?: string | null; - /** - * Exit click-through URL for the event. This field is used only for exit events. - */ - exitClickThroughUrl?: Schema$CreativeClickThroughUrl; - /** - * ID of this event. This is a required field and should not be modified after insertion. - */ - id?: string | null; - /** - * Properties for rich media popup windows. This field is used only for exit events. - */ - popupWindowProperties?: Schema$PopupWindowProperties; - /** - * Target type used by the event. - */ - targetType?: string | null; - /** - * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. - */ - videoReportingId?: string | null; - } - /** - * Contains properties of a creative field. - */ - export interface Schema$CreativeField { - /** - * Account ID of this creative field. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this creative field. This is a required field on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this creative field. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". - */ - kind?: string | null; - /** - * Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. - */ - name?: string | null; - /** - * Subaccount ID of this creative field. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Creative Field Assignment. - */ - export interface Schema$CreativeFieldAssignment { - /** - * ID of the creative field. - */ - creativeFieldId?: string | null; - /** - * ID of the creative field value. - */ - creativeFieldValueId?: string | null; - } - /** - * Creative Field List Response - */ - export interface Schema$CreativeFieldsListResponse { - /** - * Creative field collection. - */ - creativeFields?: Schema$CreativeField[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains properties of a creative field value. - */ - export interface Schema$CreativeFieldValue { - /** - * ID of this creative field value. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". - */ - kind?: string | null; - /** - * Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. - */ - value?: string | null; - } - /** - * Creative Field Value List Response - */ - export interface Schema$CreativeFieldValuesListResponse { - /** - * Creative field value collection. - */ - creativeFieldValues?: Schema$CreativeFieldValue[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains properties of a creative group. - */ - export interface Schema$CreativeGroup { - /** - * Account ID of this creative group. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this creative group. This is a required field on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. - */ - groupNumber?: number | null; - /** - * ID of this creative group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". - */ - kind?: string | null; - /** - * Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. - */ - name?: string | null; - /** - * Subaccount ID of this creative group. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Creative Group Assignment. - */ - export interface Schema$CreativeGroupAssignment { - /** - * ID of the creative group to be assigned. - */ - creativeGroupId?: string | null; - /** - * Creative group number of the creative group assignment. - */ - creativeGroupNumber?: string | null; - } - /** - * Creative Group List Response - */ - export interface Schema$CreativeGroupsListResponse { - /** - * Creative group collection. - */ - creativeGroups?: Schema$CreativeGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Creative optimization settings. - */ - export interface Schema$CreativeOptimizationConfiguration { - /** - * ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. - */ - id?: string | null; - /** - * Name of this creative optimization config. This is a required field and must be less than 129 characters long. - */ - name?: string | null; - /** - * List of optimization activities associated with this configuration. - */ - optimizationActivitys?: Schema$OptimizationActivity[]; - /** - * Optimization model for this configuration. - */ - optimizationModel?: string | null; - } - /** - * Creative Rotation. - */ - export interface Schema$CreativeRotation { - /** - * Creative assignments in this creative rotation. - */ - creativeAssignments?: Schema$CreativeAssignment[]; - /** - * Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad. - */ - creativeOptimizationConfigurationId?: string | null; - /** - * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. - */ - type?: string | null; - /** - * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. - */ - weightCalculationStrategy?: string | null; - } - /** - * Creative List Response - */ - export interface Schema$CreativesListResponse { - /** - * Creative collection. - */ - creatives?: Schema$Creative[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". - */ - export interface Schema$CrossDimensionReachReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the "breakdown" section of the report. - */ - breakdown?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. - */ - overlapMetrics?: Schema$Metric[]; - } - /** - * A custom floodlight variable. - */ - export interface Schema$CustomFloodlightVariable { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". - */ - kind?: string | null; - /** - * The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags. - */ - type?: string | null; - /** - * The value of the custom floodlight variable. The length of string must not exceed 50 characters. - */ - value?: string | null; - } - /** - * Represents a Custom Rich Media Events group. - */ - export interface Schema$CustomRichMediaEvents { - /** - * List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. - */ - filteredEventIds?: Schema$DimensionValue[]; - /** - * The kind of resource this is, in this case dfareporting#customRichMediaEvents. - */ - kind?: string | null; - } - /** - * Represents a date range. - */ - export interface Schema$DateRange { - /** - * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". - */ - endDate?: string | null; - /** - * The kind of resource this is, in this case dfareporting#dateRange. - */ - kind?: string | null; - /** - * The date range relative to the date of when the report is run. - */ - relativeDateRange?: string | null; - /** - * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". - */ - startDate?: string | null; - } - /** - * Day Part Targeting. - */ - export interface Schema$DayPartTargeting { - /** - * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" - */ - daysOfWeek?: string[] | null; - /** - * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. - */ - hoursOfDay?: number[] | null; - /** - * Whether or not to use the user's local time. If false, the America/New York time zone applies. - */ - userLocalTime?: boolean | null; - } - /** - * Contains information about a landing page deep link. - */ - export interface Schema$DeepLink { - /** - * The URL of the mobile app being linked to. - */ - appUrl?: string | null; - /** - * The fallback URL. This URL will be served to users who do not have the mobile app installed. - */ - fallbackUrl?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". - */ - kind?: string | null; - /** - * The mobile app targeted by this deep link. - */ - mobileApp?: Schema$MobileApp; - /** - * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. - */ - remarketingListIds?: string[] | null; - } - /** - * Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. - */ - export interface Schema$DefaultClickThroughEventTagProperties { - /** - * ID of the click-through event tag to apply to all ads in this entity's scope. - */ - defaultClickThroughEventTagId?: string | null; - /** - * Whether this entity should override the inherited default click-through event tag with its own defined value. - */ - overrideInheritedEventTag?: boolean | null; - } - /** - * Delivery Schedule. - */ - export interface Schema$DeliverySchedule { - /** - * Limit on the number of times an individual user can be served the ad within a specified period of time. - */ - frequencyCap?: Schema$FrequencyCap; - /** - * Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals. - */ - hardCutoff?: boolean | null; - /** - * Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive. - */ - impressionRatio?: string | null; - /** - * Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served. - */ - priority?: string | null; - } - /** - * Google Ad Manager Settings - */ - export interface Schema$DfpSettings { - /** - * Ad Manager network code for this directory site. - */ - dfpNetworkCode?: string | null; - /** - * Ad Manager network name for this directory site. - */ - dfpNetworkName?: string | null; - /** - * Whether this directory site accepts programmatic placements. - */ - programmaticPlacementAccepted?: boolean | null; - /** - * Whether this directory site is available only via Publisher Portal. - */ - publisherPortalOnly?: boolean | null; - /** - * Whether this directory site accepts publisher-paid tags. - */ - pubPaidPlacementAccepted?: boolean | null; - } - /** - * Represents a dimension. - */ - export interface Schema$Dimension { - /** - * The kind of resource this is, in this case dfareporting#dimension. - */ - kind?: string | null; - /** - * The dimension name, e.g. dfa:advertiser - */ - name?: string | null; - } - /** - * Represents a dimension filter. - */ - export interface Schema$DimensionFilter { - /** - * The name of the dimension to filter. - */ - dimensionName?: string | null; - /** - * The kind of resource this is, in this case dfareporting#dimensionFilter. - */ - kind?: string | null; - /** - * The value of the dimension to filter. - */ - value?: string | null; - } - /** - * Represents a DimensionValue resource. - */ - export interface Schema$DimensionValue { - /** - * The name of the dimension. - */ - dimensionName?: string | null; - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The ID associated with the value if available. - */ - id?: string | null; - /** - * The kind of resource this is, in this case dfareporting#dimensionValue. - */ - kind?: string | null; - /** - * Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - */ - matchType?: string | null; - /** - * The value of the dimension. - */ - value?: string | null; - } - /** - * Represents the list of DimensionValue resources. - */ - export interface Schema$DimensionValueList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The dimension values returned in this response. - */ - items?: Schema$DimensionValue[]; - /** - * The kind of list this is, in this case dfareporting#dimensionValueList. - */ - kind?: string | null; - /** - * Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. - */ - nextPageToken?: string | null; - } - /** - * Represents a DimensionValuesRequest. - */ - export interface Schema$DimensionValueRequest { - /** - * The name of the dimension for which values should be requested. - */ - dimensionName?: string | null; - /** - * The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". - */ - endDate?: string | null; - /** - * The list of filters by which to filter values. The filters are ANDed. - */ - filters?: Schema$DimensionFilter[]; - /** - * The kind of request this is, in this case dfareporting#dimensionValueRequest. - */ - kind?: string | null; - /** - * The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". - */ - startDate?: string | null; - } - /** - * 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. - */ - id?: string | null; - /** - * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" - */ - inpageTagFormats?: string[] | null; - /** - * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" - */ - interstitialTagFormats?: string[] | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". - */ - kind?: string | null; - /** - * Name of this directory site. - */ - name?: string | null; - /** - * Directory site settings. - */ - settings?: Schema$DirectorySiteSettings; - /** - * URL of this directory site. - */ - url?: string | null; - } - /** - * Directory Site Settings - */ - export interface Schema$DirectorySiteSettings { - /** - * Whether this directory site has disabled active view creatives. - */ - activeViewOptOut?: boolean | null; - /** - * Directory site Ad Manager settings. - */ - dfpSettings?: Schema$DfpSettings; - /** - * Whether this site accepts in-stream video ads. - */ - instreamVideoPlacementAccepted?: boolean | null; - /** - * Whether this site accepts interstitial ads. - */ - interstitialPlacementAccepted?: boolean | null; - } - /** - * Directory Site List Response - */ - export interface Schema$DirectorySitesListResponse { - /** - * Directory site collection. - */ - directorySites?: Schema$DirectorySite[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds. - */ - export interface Schema$DynamicTargetingKey { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". - */ - kind?: string | null; - /** - * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. - */ - name?: string | null; - /** - * ID of the object of this dynamic targeting key. This is a required field. - */ - objectId?: string | null; - /** - * Type of the object of this dynamic targeting key. This is a required field. - */ - objectType?: string | null; - } - /** - * Dynamic Targeting Key List Response - */ - export interface Schema$DynamicTargetingKeysListResponse { - /** - * Dynamic targeting key collection. - */ - dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". - */ - kind?: string | null; - } - /** - * A description of how user IDs are encrypted. - */ - export interface Schema$EncryptionInfo { - /** - * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. - */ - encryptionEntityId?: string | null; - /** - * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. - */ - encryptionEntityType?: string | null; - /** - * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. - */ - encryptionSource?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". - */ - kind?: string | null; - } - /** - * Contains properties of an event tag. - */ - export interface Schema$EventTag { - /** - * Account ID of this event tag. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. - */ - campaignId?: string | null; - /** - * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. - */ - enabledByDefault?: boolean | null; - /** - * Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. - */ - excludeFromAdxRequests?: boolean | null; - /** - * ID of this event tag. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". - */ - kind?: string | null; - /** - * Name of this event tag. This is a required field and must be less than 256 characters long. - */ - name?: string | null; - /** - * Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. - */ - siteFilterType?: string | null; - /** - * Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter. - */ - siteIds?: string[] | null; - /** - * Whether this tag is SSL-compliant or not. This is a read-only field. - */ - sslCompliant?: boolean | null; - /** - * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. - */ - status?: string | null; - /** - * Subaccount ID of this event tag. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. - */ - type?: string | null; - /** - * Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. - */ - url?: string | null; - /** - * Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. - */ - urlEscapeLevels?: number | null; - } - /** - * Event tag override information. - */ - export interface Schema$EventTagOverride { - /** - * Whether this override is enabled. - */ - enabled?: boolean | null; - /** - * ID of this event tag override. This is a read-only, auto-generated field. - */ - id?: string | null; - } - /** - * Event Tag List Response - */ - export interface Schema$EventTagsListResponse { - /** - * Event tag collection. - */ - eventTags?: Schema$EventTag[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". - */ - kind?: string | null; - } - /** - * Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE". - */ - export interface Schema$File { - /** - * The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. - */ - dateRange?: Schema$DateRange; - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The filename of the file. - */ - fileName?: string | null; - /** - * The output format of the report. Only available once the file is available. - */ - format?: string | null; - /** - * The unique ID of this report file. - */ - id?: string | null; - /** - * The kind of resource this is, in this case dfareporting#file. - */ - kind?: string | null; - /** - * The timestamp in milliseconds since epoch when this file was last modified. - */ - lastModifiedTime?: string | null; - /** - * The ID of the report this file was generated from. - */ - reportId?: string | null; - /** - * The status of the report file. - */ - status?: string | null; - /** - * The URLs where the completed report file can be downloaded. - */ - urls?: {apiUrl?: string; browserUrl?: string} | null; - } - /** - * Represents the list of File resources. - */ - export interface Schema$FileList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The files returned in this response. - */ - items?: Schema$File[]; - /** - * The kind of list this is, in this case dfareporting#fileList. - */ - kind?: string | null; - /** - * Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. - */ - nextPageToken?: string | null; - } - /** - * Flight - */ - export interface Schema$Flight { - /** - * Inventory item flight end date. - */ - endDate?: string | null; - /** - * Rate or cost of this flight. - */ - rateOrCost?: string | null; - /** - * Inventory item flight start date. - */ - startDate?: string | null; - /** - * Units of this flight. - */ - units?: string | null; - } - /** - * Floodlight Activity GenerateTag Response - */ - export interface Schema$FloodlightActivitiesGenerateTagResponse { - /** - * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. - */ - floodlightActivityTag?: string | null; - /** - * The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. - */ - globalSiteTagGlobalSnippet?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". - */ - kind?: string | null; - } - /** - * Floodlight Activity List Response - */ - export interface Schema$FloodlightActivitiesListResponse { - /** - * Floodlight activity collection. - */ - floodlightActivities?: Schema$FloodlightActivity[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains properties of a Floodlight activity. - */ - export interface Schema$FloodlightActivity { - /** - * Account ID of this floodlight activity. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. - */ - cacheBustingType?: string | null; - /** - * Counting method for conversions for this floodlight activity. This is a required field. - */ - countingMethod?: string | null; - /** - * Dynamic floodlight tags. - */ - defaultTags?: Schema$FloodlightActivityDynamicTag[]; - /** - * URL where this tag will be deployed. If specified, must be less than 256 characters long. - */ - expectedUrl?: string | null; - /** - * Floodlight activity group ID of this floodlight activity. This is a required field. - */ - floodlightActivityGroupId?: string | null; - /** - * Name of the associated floodlight activity group. This is a read-only field. - */ - floodlightActivityGroupName?: string | null; - /** - * Tag string of the associated floodlight activity group. This is a read-only field. - */ - floodlightActivityGroupTagString?: string | null; - /** - * Type of the associated floodlight activity group. This is a read-only field. - */ - floodlightActivityGroupType?: string | null; - /** - * Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. - */ - floodlightConfigurationId?: string | null; - /** - * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * The type of Floodlight tag this activity will generate. This is a required field. - */ - floodlightTagType?: string | null; - /** - * ID of this floodlight activity. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". - */ - kind?: string | null; - /** - * Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. - */ - name?: string | null; - /** - * General notes or implementation instructions for the tag. - */ - notes?: string | null; - /** - * Publisher dynamic floodlight tags. - */ - publisherTags?: Schema$FloodlightActivityPublisherDynamicTag[]; - /** - * Whether this tag should use SSL. - */ - secure?: boolean | null; - /** - * Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. - */ - sslCompliant?: boolean | null; - /** - * Whether this floodlight activity must be SSL-compliant. - */ - sslRequired?: boolean | null; - /** - * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. - */ - tagFormat?: string | null; - /** - * Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. - */ - tagString?: string | null; - /** - * List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. - */ - userDefinedVariableTypes?: string[] | null; - } - /** - * Dynamic Tag - */ - export interface Schema$FloodlightActivityDynamicTag { - /** - * ID of this dynamic tag. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Name of this tag. - */ - name?: string | null; - /** - * Tag code. - */ - tag?: string | null; - } - /** - * Contains properties of a Floodlight activity group. - */ - export interface Schema$FloodlightActivityGroup { - /** - * Account ID of this floodlight activity group. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Floodlight configuration ID of this floodlight activity group. This is a required field. - */ - floodlightConfigurationId?: string | null; - /** - * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this floodlight activity group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". - */ - kind?: string | null; - /** - * Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. - */ - name?: string | null; - /** - * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. - */ - tagString?: string | null; - /** - * Type of the floodlight activity group. This is a required field that is read-only after insertion. - */ - type?: string | null; - } - /** - * Floodlight Activity Group List Response - */ - export interface Schema$FloodlightActivityGroupsListResponse { - /** - * Floodlight activity group collection. - */ - floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Publisher Dynamic Tag - */ - export interface Schema$FloodlightActivityPublisherDynamicTag { - /** - * Whether this tag is applicable only for click-throughs. - */ - clickThrough?: boolean | null; - /** - * Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. - */ - directorySiteId?: string | null; - /** - * Dynamic floodlight tag. - */ - dynamicTag?: Schema$FloodlightActivityDynamicTag; - /** - * Site ID of this dynamic tag. - */ - siteId?: string | null; - /** - * Dimension value for the ID of the site. This is a read-only, auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this tag is applicable only for view-throughs. - */ - viewThrough?: boolean | null; - } - /** - * Contains properties of a Floodlight configuration. - */ - export interface Schema$FloodlightConfiguration { - /** - * Account ID of this floodlight configuration. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of the parent advertiser of this floodlight configuration. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether advertiser data is shared with Google Analytics. - */ - analyticsDataSharingEnabled?: boolean | null; - /** - * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. - */ - exposureToConversionEnabled?: boolean | null; - /** - * Day that will be counted as the first day of the week in reports. This is a required field. - */ - firstDayOfWeek?: string | null; - /** - * ID of this floodlight configuration. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Whether in-app attribution tracking is enabled. - */ - inAppAttributionTrackingEnabled?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". - */ - kind?: string | null; - /** - * Lookback window settings for this floodlight configuration. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Types of attribution options for natural search conversions. - */ - naturalSearchConversionAttributionOption?: string | null; - /** - * Settings for Campaign Manager Omniture integration. - */ - omnitureSettings?: Schema$OmnitureSettings; - /** - * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Configuration settings for dynamic and image floodlight tags. - */ - tagSettings?: Schema$TagSettings; - /** - * List of third-party authentication tokens enabled for this configuration. - */ - thirdPartyAuthenticationTokens?: Schema$ThirdPartyAuthenticationToken[]; - /** - * List of user defined variables enabled for this configuration. - */ - userDefinedVariableConfigurations?: Schema$UserDefinedVariableConfiguration[]; - } - /** - * Floodlight Configuration List Response - */ - export interface Schema$FloodlightConfigurationsListResponse { - /** - * Floodlight configuration collection. - */ - floodlightConfigurations?: Schema$FloodlightConfiguration[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". - */ - kind?: string | null; - } - /** - * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". - */ - export interface Schema$FloodlightReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - } - /** - * Frequency Cap. - */ - export interface Schema$FrequencyCap { - /** - * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. - */ - duration?: string | null; - /** - * Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. - */ - impressions?: string | null; - } - /** - * FsCommand. - */ - export interface Schema$FsCommand { - /** - * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. - */ - left?: number | null; - /** - * Position in the browser where the window will open. - */ - positionOption?: string | null; - /** - * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. - */ - top?: number | null; - /** - * Height of the window. - */ - windowHeight?: number | null; - /** - * Width of the window. - */ - windowWidth?: number | null; - } - /** - * Geographical Targeting. - */ - export interface Schema$GeoTargeting { - /** - * Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. - */ - cities?: Schema$City[]; - /** - * Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. - */ - countries?: Schema$Country[]; - /** - * Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. - */ - excludeCountries?: boolean | null; - /** - * Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. - */ - metros?: Schema$Metro[]; - /** - * Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. - */ - postalCodes?: Schema$PostalCode[]; - /** - * Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. - */ - regions?: Schema$Region[]; - } - /** - * Represents a buy from the Planning inventory store. - */ - export interface Schema$InventoryItem { - /** - * Account ID of this inventory item. - */ - accountId?: string | null; - /** - * Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group. - */ - adSlots?: Schema$AdSlot[]; - /** - * Advertiser ID of this inventory item. - */ - advertiserId?: string | null; - /** - * Content category ID of this inventory item. - */ - contentCategoryId?: string | null; - /** - * Estimated click-through rate of this inventory item. - */ - estimatedClickThroughRate?: string | null; - /** - * Estimated conversion rate of this inventory item. - */ - estimatedConversionRate?: string | null; - /** - * ID of this inventory item. - */ - id?: string | null; - /** - * Whether this inventory item is in plan. - */ - inPlan?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". - */ - kind?: string | null; - /** - * Information about the most recent modification of this inventory item. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots. - */ - name?: string | null; - /** - * Negotiation channel ID of this inventory item. - */ - negotiationChannelId?: string | null; - /** - * Order ID of this inventory item. - */ - orderId?: string | null; - /** - * Placement strategy ID of this inventory item. - */ - placementStrategyId?: string | null; - /** - * Pricing of this inventory item. - */ - pricing?: Schema$Pricing; - /** - * Project ID of this inventory item. - */ - projectId?: string | null; - /** - * RFP ID of this inventory item. - */ - rfpId?: string | null; - /** - * ID of the site this inventory item is associated with. - */ - siteId?: string | null; - /** - * Subaccount ID of this inventory item. - */ - subaccountId?: string | null; - /** - * Type of inventory item. - */ - type?: string | null; - } - /** - * Inventory item List Response - */ - export interface Schema$InventoryItemsListResponse { - /** - * Inventory item collection - */ - inventoryItems?: Schema$InventoryItem[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Key Value Targeting Expression. - */ - export interface Schema$KeyValueTargetingExpression { - /** - * Keyword expression being targeted by the ad. - */ - expression?: string | null; - } - /** - * Contains information about where a user's browser is taken after the user clicks an ad. - */ - export interface Schema$LandingPage { - /** - * Advertiser ID of this landing page. This is a required field. - */ - advertiserId?: string | null; - /** - * Whether this landing page has been archived. - */ - archived?: boolean | null; - /** - * Links that will direct the user to a mobile app, if installed. - */ - deepLinks?: Schema$DeepLink[]; - /** - * ID of this landing page. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". - */ - kind?: string | null; - /** - * Name of this landing page. This is a required field. It must be less than 256 characters long. - */ - name?: string | null; - /** - * URL of this landing page. This is a required field. - */ - url?: string | null; - } - /** - * Contains information about a language that can be targeted by ads. - */ - export interface Schema$Language { - /** - * Language ID of this language. This is the ID used for targeting and generating reports. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". - */ - kind?: string | null; - /** - * Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. - */ - languageCode?: string | null; - /** - * Name of this language. - */ - name?: string | null; - } - /** - * Language List Response - */ - export interface Schema$LanguagesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". - */ - kind?: string | null; - /** - * Language collection. - */ - languages?: Schema$Language[]; - } - /** - * Language Targeting. - */ - export interface Schema$LanguageTargeting { - /** - * Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. - */ - languages?: Schema$Language[]; - } - /** - * Modification timestamp. - */ - export interface Schema$LastModifiedInfo { - /** - * Timestamp of the last change in milliseconds since epoch. - */ - time?: string | null; - } - /** - * A group clause made up of list population terms representing constraints joined by ORs. - */ - export interface Schema$ListPopulationClause { - /** - * Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. - */ - terms?: Schema$ListPopulationTerm[]; - } - /** - * Remarketing List Population Rule. - */ - export interface Schema$ListPopulationRule { - /** - * Floodlight activity ID associated with this rule. This field can be left blank. - */ - floodlightActivityId?: string | null; - /** - * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. - */ - floodlightActivityName?: string | null; - /** - * Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. - */ - listPopulationClauses?: Schema$ListPopulationClause[]; - } - /** - * Remarketing List Population Rule Term. - */ - export interface Schema$ListPopulationTerm { - /** - * Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. - */ - contains?: boolean | null; - /** - * Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - negation?: boolean | null; - /** - * Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - operator?: string | null; - /** - * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. - */ - remarketingListId?: string | null; - /** - * List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. - */ - type?: string | null; - /** - * Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - value?: string | null; - /** - * Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. - */ - variableFriendlyName?: string | null; - /** - * Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - variableName?: string | null; - } - /** - * Remarketing List Targeting Expression. - */ - export interface Schema$ListTargetingExpression { - /** - * Expression describing which lists are being targeted by the ad. - */ - expression?: string | null; - } - /** - * Lookback configuration settings. - */ - export interface Schema$LookbackConfiguration { - /** - * Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. - */ - clickDuration?: number | null; - /** - * Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. - */ - postImpressionActivitiesDuration?: number | null; - } - /** - * Represents a metric. - */ - export interface Schema$Metric { - /** - * The kind of resource this is, in this case dfareporting#metric. - */ - kind?: string | null; - /** - * The metric name, e.g. dfa:impressions - */ - name?: string | null; - } - /** - * Contains information about a metro region that can be targeted by ads. - */ - export interface Schema$Metro { - /** - * Country code of the country to which this metro region belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this metro region belongs. - */ - countryDartId?: string | null; - /** - * DART ID of this metro region. - */ - dartId?: string | null; - /** - * DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. - */ - dmaId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". - */ - kind?: string | null; - /** - * Metro code of this metro region. This is equivalent to dma_id. - */ - metroCode?: string | null; - /** - * Name of this metro region. - */ - name?: string | null; - } - /** - * Metro List Response - */ - export interface Schema$MetrosListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". - */ - kind?: string | null; - /** - * Metro collection. - */ - metros?: Schema$Metro[]; - } - /** - * Contains information about a mobile app. Used as a landing page deep link. - */ - export interface Schema$MobileApp { - /** - * Mobile app directory. - */ - directory?: string | null; - /** - * ID of this mobile app. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". - */ - kind?: string | null; - /** - * Publisher name. - */ - publisherName?: string | null; - /** - * Title of this mobile app. - */ - title?: string | null; - } - /** - * Mobile app List Response - */ - export interface Schema$MobileAppsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". - */ - kind?: string | null; - /** - * Mobile apps collection. - */ - mobileApps?: Schema$MobileApp[]; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains information about a mobile carrier that can be targeted by ads. - */ - export interface Schema$MobileCarrier { - /** - * Country code of the country to which this mobile carrier belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this mobile carrier belongs. - */ - countryDartId?: string | null; - /** - * ID of this mobile carrier. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". - */ - kind?: string | null; - /** - * Name of this mobile carrier. - */ - name?: string | null; - } - /** - * Mobile Carrier List Response - */ - export interface Schema$MobileCarriersListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". - */ - kind?: string | null; - /** - * Mobile carrier collection. - */ - mobileCarriers?: Schema$MobileCarrier[]; - } - /** - * Object Filter. - */ - export interface Schema$ObjectFilter { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". - */ - kind?: string | null; - /** - * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. - */ - objectIds?: string[] | null; - /** - * Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list. - */ - status?: string | null; - } - /** - * Offset Position. - */ - export interface Schema$OffsetPosition { - /** - * Offset distance from left side of an asset or a window. - */ - left?: number | null; - /** - * Offset distance from top side of an asset or a window. - */ - top?: number | null; - } - /** - * Omniture Integration Settings. - */ - export interface Schema$OmnitureSettings { - /** - * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. - */ - omnitureCostDataEnabled?: boolean | null; - /** - * Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. - */ - omnitureIntegrationEnabled?: boolean | null; - } - /** - * Contains information about an operating system that can be targeted by ads. - */ - export interface Schema$OperatingSystem { - /** - * DART ID of this operating system. This is the ID used for targeting. - */ - dartId?: string | null; - /** - * Whether this operating system is for desktop. - */ - desktop?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". - */ - kind?: string | null; - /** - * Whether this operating system is for mobile. - */ - mobile?: boolean | null; - /** - * Name of this operating system. - */ - name?: string | null; - } - /** - * Operating System List Response - */ - export interface Schema$OperatingSystemsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". - */ - kind?: string | null; - /** - * Operating system collection. - */ - operatingSystems?: Schema$OperatingSystem[]; - } - /** - * Contains information about a particular version of an operating system that can be targeted by ads. - */ - export interface Schema$OperatingSystemVersion { - /** - * ID of this operating system version. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". - */ - kind?: string | null; - /** - * Major version (leftmost number) of this operating system version. - */ - majorVersion?: string | null; - /** - * Minor version (number after the first dot) of this operating system version. - */ - minorVersion?: string | null; - /** - * Name of this operating system version. - */ - name?: string | null; - /** - * Operating system of this operating system version. - */ - operatingSystem?: Schema$OperatingSystem; - } - /** - * Operating System Version List Response - */ - export interface Schema$OperatingSystemVersionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". - */ - kind?: string | null; - /** - * Operating system version collection. - */ - operatingSystemVersions?: Schema$OperatingSystemVersion[]; - } - /** - * Creative optimization activity. - */ - export interface Schema$OptimizationActivity { - /** - * Floodlight activity ID of this optimization activity. This is a required field. - */ - floodlightActivityId?: string | null; - /** - * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. - */ - floodlightActivityIdDimensionValue?: Schema$DimensionValue; - /** - * Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. - */ - weight?: number | null; - } - /** - * Describes properties of a Planning order. - */ - export interface Schema$Order { - /** - * Account ID of this order. - */ - accountId?: string | null; - /** - * Advertiser ID of this order. - */ - advertiserId?: string | null; - /** - * IDs for users that have to approve documents created for this order. - */ - approverUserProfileIds?: string[] | null; - /** - * Buyer invoice ID associated with this order. - */ - buyerInvoiceId?: string | null; - /** - * Name of the buyer organization. - */ - buyerOrganizationName?: string | null; - /** - * Comments in this order. - */ - comments?: string | null; - /** - * Contacts for this order. - */ - contacts?: Schema$OrderContact[]; - /** - * ID of this order. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". - */ - kind?: string | null; - /** - * Information about the most recent modification of this order. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this order. - */ - name?: string | null; - /** - * Notes of this order. - */ - notes?: string | null; - /** - * ID of the terms and conditions template used in this order. - */ - planningTermId?: string | null; - /** - * Project ID of this order. - */ - projectId?: string | null; - /** - * Seller order ID associated with this order. - */ - sellerOrderId?: string | null; - /** - * Name of the seller organization. - */ - sellerOrganizationName?: string | null; - /** - * Site IDs this order is associated with. - */ - siteId?: string[] | null; - /** - * Free-form site names this order is associated with. - */ - siteNames?: string[] | null; - /** - * Subaccount ID of this order. - */ - subaccountId?: string | null; - /** - * Terms and conditions of this order. - */ - termsAndConditions?: string | null; - } - /** - * Contact of an order. - */ - export interface Schema$OrderContact { - /** - * Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID. - */ - contactInfo?: string | null; - /** - * Name of this contact. - */ - contactName?: string | null; - /** - * Title of this contact. - */ - contactTitle?: string | null; - /** - * Type of this contact. - */ - contactType?: string | null; - /** - * ID of the user profile containing the signature that will be embedded into order documents. - */ - signatureUserProfileId?: string | null; - } - /** - * Contains properties of a Planning order document. - */ - export interface Schema$OrderDocument { - /** - * Account ID of this order document. - */ - accountId?: string | null; - /** - * Advertiser ID of this order document. - */ - advertiserId?: string | null; - /** - * The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. - */ - amendedOrderDocumentId?: string | null; - /** - * IDs of users who have approved this order document. - */ - approvedByUserProfileIds?: string[] | null; - /** - * Whether this order document is cancelled. - */ - cancelled?: boolean | null; - /** - * Information about the creation of this order document. - */ - createdInfo?: Schema$LastModifiedInfo; - /** - * Effective date of this order document. - */ - effectiveDate?: string | null; - /** - * ID of this order document. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". - */ - kind?: string | null; - /** - * List of email addresses that received the last sent document. - */ - lastSentRecipients?: string[] | null; - /** - * Timestamp of the last email sent with this order document. - */ - lastSentTime?: string | null; - /** - * ID of the order from which this order document is created. - */ - orderId?: string | null; - /** - * Project ID of this order document. - */ - projectId?: string | null; - /** - * Whether this order document has been signed. - */ - signed?: boolean | null; - /** - * Subaccount ID of this order document. - */ - subaccountId?: string | null; - /** - * Title of this order document. - */ - title?: string | null; - /** - * Type of this order document - */ - type?: string | null; - } - /** - * Order document List Response - */ - export interface Schema$OrderDocumentsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Order document collection - */ - orderDocuments?: Schema$OrderDocument[]; - } - /** - * Order List Response - */ - export interface Schema$OrdersListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Order collection. - */ - orders?: Schema$Order[]; - } - /** - * Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". - */ - export interface Schema$PathToConversionReportCompatibleFields { - /** - * Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. - */ - conversionDimensions?: Schema$Dimension[]; - /** - * Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report. - */ - customFloodlightVariables?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report. - */ - perInteractionDimensions?: Schema$Dimension[]; - } - /** - * Contains properties of a placement. - */ - export interface Schema$Placement { - /** - * Account ID of this placement. This field can be left blank. - */ - accountId?: string | null; - /** - * Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. - */ - adBlockingOptOut?: boolean | null; - /** - * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. - */ - additionalSizes?: Schema$Size[]; - /** - * Advertiser ID of this placement. This field can be left blank. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this placement is archived. - */ - archived?: boolean | null; - /** - * Campaign ID of this placement. This field is a required field on insertion. - */ - campaignId?: string | null; - /** - * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Comments for this placement. - */ - comment?: string | null; - /** - * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. - */ - compatibility?: string | null; - /** - * ID of the content category assigned to this placement. - */ - contentCategoryId?: string | null; - /** - * Information about the creation of this placement. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. - */ - directorySiteId?: string | null; - /** - * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * External ID for this placement. - */ - externalId?: string | null; - /** - * ID of this placement. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this placement. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key name of this placement. This is a read-only, auto-generated field. - */ - keyName?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". - */ - kind?: string | null; - /** - * Information about the most recent modification of this placement. This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Lookback window settings for this placement. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Name of this placement.This is a required field and must be less than 256 characters long. - */ - name?: string | null; - /** - * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. - */ - paymentApproved?: boolean | null; - /** - * Payment source for this placement. This is a required field that is read-only after insertion. - */ - paymentSource?: string | null; - /** - * ID of this placement's group, if applicable. - */ - placementGroupId?: string | null; - /** - * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. - */ - placementGroupIdDimensionValue?: Schema$DimensionValue; - /** - * ID of the placement strategy assigned to this placement. - */ - placementStrategyId?: string | null; - /** - * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. - */ - pricingSchedule?: Schema$PricingSchedule; - /** - * Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. - */ - primary?: boolean | null; - /** - * Information about the last publisher update. This is a read-only field. - */ - publisherUpdateInfo?: Schema$LastModifiedInfo; - /** - * Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. - */ - siteId?: string | null; - /** - * Dimension value for the ID of the site. This is a read-only, auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. - */ - size?: Schema$Size; - /** - * Whether creatives assigned to this placement must be SSL-compliant. - */ - sslRequired?: boolean | null; - /** - * Third-party placement status. - */ - status?: string | null; - /** - * Subaccount ID of this placement. This field can be left blank. - */ - subaccountId?: string | null; - /** - * Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" - */ - tagFormats?: string[] | null; - /** - * Tag settings for this placement. - */ - tagSetting?: Schema$TagSetting; - /** - * Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. - */ - videoActiveViewOptOut?: boolean | null; - /** - * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. - */ - videoSettings?: Schema$VideoSettings; - /** - * VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. - */ - vpaidAdapterChoice?: string | null; - } - /** - * Placement Assignment. - */ - export interface Schema$PlacementAssignment { - /** - * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. - */ - active?: boolean | null; - /** - * ID of the placement to be assigned. This is a required field. - */ - placementId?: string | null; - /** - * Dimension value for the ID of the placement. This is a read-only, auto-generated field. - */ - placementIdDimensionValue?: Schema$DimensionValue; - /** - * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated. - */ - sslRequired?: boolean | null; - } - /** - * Contains properties of a package or roadblock. - */ - export interface Schema$PlacementGroup { - /** - * Account ID of this placement group. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this placement group. This is a required field on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this placement group is archived. - */ - archived?: boolean | null; - /** - * Campaign ID of this placement group. This field is required on insertion. - */ - campaignId?: string | null; - /** - * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. - */ - childPlacementIds?: string[] | null; - /** - * Comments for this placement group. - */ - comment?: string | null; - /** - * ID of the content category assigned to this placement group. - */ - contentCategoryId?: string | null; - /** - * Information about the creation of this placement group. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. - */ - directorySiteId?: string | null; - /** - * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * External ID for this placement. - */ - externalId?: string | null; - /** - * ID of this placement group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". - */ - kind?: string | null; - /** - * Information about the most recent modification of this placement group. This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this placement group. This is a required field and must be less than 256 characters long. - */ - name?: string | null; - /** - * Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. - */ - placementGroupType?: string | null; - /** - * ID of the placement strategy assigned to this placement group. - */ - placementStrategyId?: string | null; - /** - * Pricing schedule of this placement group. This field is required on insertion. - */ - pricingSchedule?: Schema$PricingSchedule; - /** - * ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. - */ - primaryPlacementId?: string | null; - /** - * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. - */ - primaryPlacementIdDimensionValue?: Schema$DimensionValue; - /** - * Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. - */ - siteId?: string | null; - /** - * Dimension value for the ID of the site. This is a read-only, auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Subaccount ID of this placement group. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Placement Group List Response - */ - export interface Schema$PlacementGroupsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Placement group collection. - */ - placementGroups?: Schema$PlacementGroup[]; - } - /** - * Placement GenerateTags Response - */ - export interface Schema$PlacementsGenerateTagsResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". - */ - kind?: string | null; - /** - * Set of generated tags for the specified placements. - */ - placementTags?: Schema$PlacementTag[]; - } - /** - * Placement List Response - */ - export interface Schema$PlacementsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Placement collection. - */ - placements?: Schema$Placement[]; - } - /** - * Placement Strategy List Response - */ - export interface Schema$PlacementStrategiesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Placement strategy collection. - */ - placementStrategies?: Schema$PlacementStrategy[]; - } - /** - * Contains properties of a placement strategy. - */ - export interface Schema$PlacementStrategy { - /** - * Account ID of this placement strategy.This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * ID of this placement strategy. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". - */ - kind?: string | null; - /** - * Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account. - */ - name?: string | null; - } - /** - * Placement Tag - */ - export interface Schema$PlacementTag { - /** - * Placement ID - */ - placementId?: string | null; - /** - * Tags generated for this placement. - */ - tagDatas?: Schema$TagData[]; - } - /** - * Contains information about a platform type that can be targeted by ads. - */ - export interface Schema$PlatformType { - /** - * ID of this platform type. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". - */ - kind?: string | null; - /** - * Name of this platform type. - */ - name?: string | null; - } - /** - * Platform Type List Response - */ - export interface Schema$PlatformTypesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". - */ - kind?: string | null; - /** - * Platform type collection. - */ - platformTypes?: Schema$PlatformType[]; - } - /** - * Popup Window Properties. - */ - export interface Schema$PopupWindowProperties { - /** - * Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID - */ - dimension?: Schema$Size; - /** - * Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES. - */ - offset?: Schema$OffsetPosition; - /** - * Popup window position either centered or at specific coordinate. - */ - positionType?: string | null; - /** - * Whether to display the browser address bar. - */ - showAddressBar?: boolean | null; - /** - * Whether to display the browser menu bar. - */ - showMenuBar?: boolean | null; - /** - * Whether to display the browser scroll bar. - */ - showScrollBar?: boolean | null; - /** - * Whether to display the browser status bar. - */ - showStatusBar?: boolean | null; - /** - * Whether to display the browser tool bar. - */ - showToolBar?: boolean | null; - /** - * Title of popup window. - */ - title?: string | null; - } - /** - * Contains information about a postal code that can be targeted by ads. - */ - export interface Schema$PostalCode { - /** - * Postal code. This is equivalent to the id field. - */ - code?: string | null; - /** - * Country code of the country to which this postal code belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this postal code belongs. - */ - countryDartId?: string | null; - /** - * ID of this postal code. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". - */ - kind?: string | null; - } - /** - * Postal Code List Response - */ - export interface Schema$PostalCodesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". - */ - kind?: string | null; - /** - * Postal code collection. - */ - postalCodes?: Schema$PostalCode[]; - } - /** - * Pricing Information - */ - export interface Schema$Pricing { - /** - * Cap cost type of this inventory item. - */ - capCostType?: string | null; - /** - * End date of this inventory item. - */ - endDate?: string | null; - /** - * Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. - */ - flights?: Schema$Flight[]; - /** - * Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary. - */ - groupType?: string | null; - /** - * Pricing type of this inventory item. - */ - pricingType?: string | null; - /** - * Start date of this inventory item. - */ - startDate?: string | null; - } - /** - * Pricing Schedule - */ - export interface Schema$PricingSchedule { - /** - * Placement cap cost option. - */ - capCostOption?: string | null; - /** - * Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion. - */ - endDate?: string | null; - /** - * Whether this placement is flighted. If true, pricing periods will be computed automatically. - */ - flighted?: boolean | null; - /** - * Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. - */ - floodlightActivityId?: string | null; - /** - * Pricing periods for this placement. - */ - pricingPeriods?: Schema$PricingSchedulePricingPeriod[]; - /** - * Placement pricing type. This field is required on insertion. - */ - pricingType?: string | null; - /** - * Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion. - */ - startDate?: string | null; - /** - * Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. - */ - testingStartDate?: string | null; - } - /** - * Pricing Period - */ - export interface Schema$PricingSchedulePricingPeriod { - /** - * Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. - */ - endDate?: string | null; - /** - * Comments for this pricing period. - */ - pricingComment?: string | null; - /** - * Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. - */ - rateOrCostNanos?: string | null; - /** - * Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. - */ - startDate?: string | null; - /** - * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. - */ - units?: string | null; - } - /** - * Contains properties of a Planning project. - */ - export interface Schema$Project { - /** - * Account ID of this project. - */ - accountId?: string | null; - /** - * Advertiser ID of this project. - */ - advertiserId?: string | null; - /** - * Audience age group of this project. - */ - audienceAgeGroup?: string | null; - /** - * Audience gender of this project. - */ - audienceGender?: string | null; - /** - * Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar. - */ - budget?: string | null; - /** - * Client billing code of this project. - */ - clientBillingCode?: string | null; - /** - * Name of the project client. - */ - clientName?: string | null; - /** - * End date of the project. - */ - endDate?: string | null; - /** - * ID of this project. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". - */ - kind?: string | null; - /** - * Information about the most recent modification of this project. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this project. - */ - name?: string | null; - /** - * Overview of this project. - */ - overview?: string | null; - /** - * Start date of the project. - */ - startDate?: string | null; - /** - * Subaccount ID of this project. - */ - subaccountId?: string | null; - /** - * Number of clicks that the advertiser is targeting. - */ - targetClicks?: string | null; - /** - * Number of conversions that the advertiser is targeting. - */ - targetConversions?: string | null; - /** - * CPA that the advertiser is targeting. - */ - targetCpaNanos?: string | null; - /** - * CPC that the advertiser is targeting. - */ - targetCpcNanos?: string | null; - /** - * vCPM from Active View that the advertiser is targeting. - */ - targetCpmActiveViewNanos?: string | null; - /** - * CPM that the advertiser is targeting. - */ - targetCpmNanos?: string | null; - /** - * Number of impressions that the advertiser is targeting. - */ - targetImpressions?: string | null; - } - /** - * Project List Response - */ - export interface Schema$ProjectsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Project collection. - */ - projects?: Schema$Project[]; - } - /** - * Represents fields that are compatible to be selected for a report of type "REACH". - */ - export interface Schema$ReachReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. - */ - pivotedActivityMetrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report. - */ - reachByFrequencyMetrics?: Schema$Metric[]; - } - /** - * Represents a recipient. - */ - export interface Schema$Recipient { - /** - * The delivery type for the recipient. - */ - deliveryType?: string | null; - /** - * The email address of the recipient. - */ - email?: string | null; - /** - * The kind of resource this is, in this case dfareporting#recipient. - */ - kind?: string | null; - } - /** - * Contains information about a region that can be targeted by ads. - */ - export interface Schema$Region { - /** - * Country code of the country to which this region belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this region belongs. - */ - countryDartId?: string | null; - /** - * DART ID of this region. - */ - dartId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". - */ - kind?: string | null; - /** - * Name of this region. - */ - name?: string | null; - /** - * Region code. - */ - regionCode?: string | null; - } - /** - * Region List Response - */ - export interface Schema$RegionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". - */ - kind?: string | null; - /** - * Region collection. - */ - regions?: Schema$Region[]; - } - /** - * Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. - */ - export interface Schema$RemarketingList { - /** - * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. - */ - accountId?: string | null; - /** - * Whether this remarketing list is active. - */ - active?: boolean | null; - /** - * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Remarketing list description. - */ - description?: string | null; - /** - * Remarketing list ID. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". - */ - kind?: string | null; - /** - * Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. - */ - lifeSpan?: string | null; - /** - * Rule used to populate the remarketing list with users. - */ - listPopulationRule?: Schema$ListPopulationRule; - /** - * Number of users currently in the list. This is a read-only field. - */ - listSize?: string | null; - /** - * Product from which this remarketing list was originated. - */ - listSource?: string | null; - /** - * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. - */ - name?: string | null; - /** - * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. - */ - subaccountId?: string | null; - } - /** - * Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers. - */ - export interface Schema$RemarketingListShare { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". - */ - kind?: string | null; - /** - * Remarketing list ID. This is a read-only, auto-generated field. - */ - remarketingListId?: string | null; - /** - * Accounts that the remarketing list is shared with. - */ - sharedAccountIds?: string[] | null; - /** - * Advertisers that the remarketing list is shared with. - */ - sharedAdvertiserIds?: string[] | null; - } - /** - * Remarketing list response - */ - export interface Schema$RemarketingListsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Remarketing list collection. - */ - remarketingLists?: Schema$RemarketingList[]; - } - /** - * Represents a Report resource. - */ - export interface Schema$Report { - /** - * The account ID to which this report belongs. - */ - accountId?: string | null; - /** - * The report criteria for a report of type "STANDARD". - */ - criteria?: { - activities?: Schema$Activities; - customRichMediaEvents?: Schema$CustomRichMediaEvents; - dateRange?: Schema$DateRange; - dimensionFilters?: Schema$DimensionValue[]; - dimensions?: Schema$SortedDimension[]; - metricNames?: string[]; - } | null; - /** - * The report criteria for a report of type "CROSS_DIMENSION_REACH". - */ - crossDimensionReachCriteria?: { - breakdown?: Schema$SortedDimension[]; - dateRange?: Schema$DateRange; - dimension?: string; - dimensionFilters?: Schema$DimensionValue[]; - metricNames?: string[]; - overlapMetricNames?: string[]; - pivoted?: boolean; - } | null; - /** - * The report's email delivery settings. - */ - delivery?: { - emailOwner?: boolean; - emailOwnerDeliveryType?: string; - message?: string; - recipients?: Schema$Recipient[]; - } | null; - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The filename used when generating report files for this report. - */ - fileName?: string | null; - /** - * The report criteria for a report of type "FLOODLIGHT". - */ - floodlightCriteria?: { - customRichMediaEvents?: Schema$DimensionValue[]; - dateRange?: Schema$DateRange; - dimensionFilters?: Schema$DimensionValue[]; - dimensions?: Schema$SortedDimension[]; - floodlightConfigId?: Schema$DimensionValue; - metricNames?: string[]; - reportProperties?: { - includeAttributedIPConversions?: boolean; - includeUnattributedCookieConversions?: boolean; - includeUnattributedIPConversions?: boolean; - }; - } | null; - /** - * The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format. - */ - format?: string | null; - /** - * The unique ID identifying this report resource. - */ - id?: string | null; - /** - * The kind of resource this is, in this case dfareporting#report. - */ - kind?: string | null; - /** - * The timestamp (in milliseconds since epoch) of when this report was last modified. - */ - lastModifiedTime?: string | null; - /** - * The name of the report. - */ - name?: string | null; - /** - * The user profile id of the owner of this report. - */ - ownerProfileId?: string | null; - /** - * The report criteria for a report of type "PATH_TO_CONVERSION". - */ - pathToConversionCriteria?: { - activityFilters?: Schema$DimensionValue[]; - conversionDimensions?: Schema$SortedDimension[]; - customFloodlightVariables?: Schema$SortedDimension[]; - customRichMediaEvents?: Schema$DimensionValue[]; - dateRange?: Schema$DateRange; - floodlightConfigId?: Schema$DimensionValue; - metricNames?: string[]; - perInteractionDimensions?: Schema$SortedDimension[]; - reportProperties?: { - clicksLookbackWindow?: number; - impressionsLookbackWindow?: number; - includeAttributedIPConversions?: boolean; - includeUnattributedCookieConversions?: boolean; - includeUnattributedIPConversions?: boolean; - maximumClickInteractions?: number; - maximumImpressionInteractions?: number; - maximumInteractionGap?: number; - pivotOnInteractionPath?: boolean; - }; - } | null; - /** - * The report criteria for a report of type "REACH". - */ - reachCriteria?: { - activities?: Schema$Activities; - customRichMediaEvents?: Schema$CustomRichMediaEvents; - dateRange?: Schema$DateRange; - dimensionFilters?: Schema$DimensionValue[]; - dimensions?: Schema$SortedDimension[]; - enableAllDimensionCombinations?: boolean; - metricNames?: string[]; - reachByFrequencyMetricNames?: string[]; - } | null; - /** - * The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY". - */ - schedule?: { - active?: boolean; - every?: number; - expirationDate?: string; - repeats?: string; - repeatsOnWeekDays?: string[]; - runsOnDayOfMonth?: string; - startDate?: string; - } | null; - /** - * The subaccount ID to which this report belongs if applicable. - */ - subAccountId?: string | null; - /** - * The type of the report. - */ - type?: string | null; - } - /** - * Represents fields that are compatible to be selected for a report of type "STANDARD". - */ - export interface Schema$ReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#reportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. - */ - pivotedActivityMetrics?: Schema$Metric[]; - } - /** - * Represents the list of reports. - */ - export interface Schema$ReportList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The reports returned in this response. - */ - items?: Schema$Report[]; - /** - * The kind of list this is, in this case dfareporting#reportList. - */ - kind?: string | null; - /** - * Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. - */ - nextPageToken?: string | null; - } - /** - * Reporting Configuration - */ - export interface Schema$ReportsConfiguration { - /** - * Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. - */ - exposureToConversionEnabled?: boolean | null; - /** - * Default lookback windows for new advertisers in this account. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - */ - reportGenerationTimeZoneId?: string | null; - } - /** - * Rich Media Exit Override. - */ - export interface Schema$RichMediaExitOverride { - /** - * Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. - */ - enabled?: boolean | null; - /** - * ID for the override to refer to a specific exit in the creative. - */ - exitId?: string | null; - } - /** - * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. - */ - export interface Schema$Rule { - /** - * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. - */ - assetId?: string | null; - /** - * A user-friendly name for this rule. This is a required field. - */ - name?: string | null; - /** - * A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field. - */ - targetingTemplateId?: string | null; - } - /** - * Contains properties of a site. - */ - export interface Schema$Site { - /** - * Account ID of this site. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Whether this site is approved. - */ - approved?: boolean | null; - /** - * Directory site associated with this site. This is a required field that is read-only after insertion. - */ - directorySiteId?: string | null; - /** - * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this site. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this site. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key name of this site. This is a read-only, auto-generated field. - */ - keyName?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". - */ - kind?: string | null; - /** - * Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. - */ - name?: string | null; - /** - * Site contacts. - */ - siteContacts?: Schema$SiteContact[]; - /** - * Site-wide settings. - */ - siteSettings?: Schema$SiteSettings; - /** - * Subaccount ID of this site. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Site Contact - */ - export interface Schema$SiteContact { - /** - * Address of this site contact. - */ - address?: string | null; - /** - * Site contact type. - */ - contactType?: string | null; - /** - * Email address of this site contact. This is a required field. - */ - email?: string | null; - /** - * First name of this site contact. - */ - firstName?: string | null; - /** - * ID of this site contact. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Last name of this site contact. - */ - lastName?: string | null; - /** - * Primary phone number of this site contact. - */ - phone?: string | null; - /** - * Title or designation of this site contact. - */ - title?: string | null; - } - /** - * Site Settings - */ - export interface Schema$SiteSettings { - /** - * Whether active view creatives are disabled for this site. - */ - activeViewOptOut?: boolean | null; - /** - * Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. - */ - adBlockingOptOut?: boolean | null; - /** - * Whether new cookies are disabled for this site. - */ - disableNewCookie?: boolean | null; - /** - * Configuration settings for dynamic and image floodlight tags. - */ - tagSetting?: Schema$TagSetting; - /** - * Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. - */ - videoActiveViewOptOutTemplate?: boolean | null; - /** - * Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. - */ - vpaidAdapterChoiceTemplate?: string | null; - } - /** - * Site List Response - */ - export interface Schema$SitesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Site collection. - */ - sites?: Schema$Site[]; - } - /** - * Represents the dimensions of ads, placements, creatives, or creative assets. - */ - export interface Schema$Size { - /** - * Height of this size. Acceptable values are 0 to 32767, inclusive. - */ - height?: number | null; - /** - * IAB standard size. This is a read-only, auto-generated field. - */ - iab?: boolean | null; - /** - * ID of this size. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - */ - kind?: string | null; - /** - * Width of this size. Acceptable values are 0 to 32767, inclusive. - */ - width?: number | null; - } - /** - * Size List Response - */ - export interface Schema$SizesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". - */ - kind?: string | null; - /** - * Size collection. - */ - sizes?: Schema$Size[]; - } - /** - * Skippable Settings - */ - export interface Schema$SkippableSetting { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". - */ - kind?: string | null; - /** - * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. - */ - progressOffset?: Schema$VideoOffset; - /** - * Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. - */ - skipOffset?: Schema$VideoOffset; - /** - * Whether the user can skip creatives served to this placement. - */ - skippable?: boolean | null; - } - /** - * Represents a sorted dimension. - */ - export interface Schema$SortedDimension { - /** - * The kind of resource this is, in this case dfareporting#sortedDimension. - */ - kind?: string | null; - /** - * The name of the dimension. - */ - name?: string | null; - /** - * An optional sort order for the dimension column. - */ - sortOrder?: string | null; - } - /** - * Contains properties of a Campaign Manager subaccount. - */ - export interface Schema$Subaccount { - /** - * ID of the account that contains this subaccount. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * IDs of the available user role permissions for this subaccount. - */ - availablePermissionIds?: string[] | null; - /** - * ID of this subaccount. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". - */ - kind?: string | null; - /** - * Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. - */ - name?: string | null; - } - /** - * Subaccount List Response - */ - export interface Schema$SubaccountsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Subaccount collection. - */ - subaccounts?: Schema$Subaccount[]; - } - /** - * Placement Tag Data - */ - export interface Schema$TagData { - /** - * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. - */ - adId?: string | null; - /** - * Tag string to record a click. - */ - clickTag?: string | null; - /** - * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. - */ - creativeId?: string | null; - /** - * TagData tag format of this tag. - */ - format?: string | null; - /** - * Tag string for serving an ad. - */ - impressionTag?: string | null; - } - /** - * Tag Settings - */ - export interface Schema$TagSetting { - /** - * Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. - */ - additionalKeyValues?: string | null; - /** - * Whether static landing page URLs should be included in the tags. This setting applies only to placements. - */ - includeClickThroughUrls?: boolean | null; - /** - * Whether click-tracking string should be included in the tags. - */ - includeClickTracking?: boolean | null; - /** - * Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. - */ - keywordOption?: string | null; - } - /** - * Dynamic and Image Tag Settings. - */ - export interface Schema$TagSettings { - /** - * Whether dynamic floodlight tags are enabled. - */ - dynamicTagEnabled?: boolean | null; - /** - * Whether image tags are enabled. - */ - imageTagEnabled?: boolean | null; - } - /** - * Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource. - */ - export interface Schema$TargetableRemarketingList { - /** - * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. - */ - accountId?: string | null; - /** - * Whether this targetable remarketing list is active. - */ - active?: boolean | null; - /** - * Dimension value for the advertiser ID that owns this targetable remarketing list. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Targetable remarketing list description. - */ - description?: string | null; - /** - * Targetable remarketing list ID. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". - */ - kind?: string | null; - /** - * Number of days that a user should remain in the targetable remarketing list without an impression. - */ - lifeSpan?: string | null; - /** - * Number of users currently in the list. This is a read-only field. - */ - listSize?: string | null; - /** - * Product from which this targetable remarketing list was originated. - */ - listSource?: string | null; - /** - * Name of the targetable remarketing list. Is no greater than 128 characters long. - */ - name?: string | null; - /** - * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. - */ - subaccountId?: string | null; - } - /** - * Targetable remarketing list response - */ - export interface Schema$TargetableRemarketingListsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Targetable remarketing list collection. - */ - targetableRemarketingLists?: Schema$TargetableRemarketingList[]; - } - /** - * Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. - */ - export interface Schema$TargetingTemplate { - /** - * Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. - */ - accountId?: string | null; - /** - * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Time and day targeting criteria. - */ - dayPartTargeting?: Schema$DayPartTargeting; - /** - * Geographical targeting criteria. - */ - geoTargeting?: Schema$GeoTargeting; - /** - * ID of this targeting template. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Key-value targeting criteria. - */ - keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". - */ - kind?: string | null; - /** - * Language targeting criteria. - */ - languageTargeting?: Schema$LanguageTargeting; - /** - * Remarketing list targeting criteria. - */ - listTargetingExpression?: Schema$ListTargetingExpression; - /** - * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. - */ - name?: string | null; - /** - * Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. - */ - subaccountId?: string | null; - /** - * Technology platform targeting criteria. - */ - technologyTargeting?: Schema$TechnologyTargeting; - } - /** - * Targeting Template List Response - */ - export interface Schema$TargetingTemplatesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Targeting template collection. - */ - targetingTemplates?: Schema$TargetingTemplate[]; - } - /** - * Target Window. - */ - export interface Schema$TargetWindow { - /** - * User-entered value. - */ - customHtml?: string | null; - /** - * Type of browser window for which the backup image of the flash creative can be displayed. - */ - targetWindowOption?: string | null; - } - /** - * Technology Targeting. - */ - export interface Schema$TechnologyTargeting { - /** - * Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. - */ - browsers?: Schema$Browser[]; - /** - * Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. - */ - connectionTypes?: Schema$ConnectionType[]; - /** - * Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. - */ - mobileCarriers?: Schema$MobileCarrier[]; - /** - * Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. - */ - operatingSystems?: Schema$OperatingSystem[]; - /** - * Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. - */ - operatingSystemVersions?: Schema$OperatingSystemVersion[]; - /** - * Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. - */ - platformTypes?: Schema$PlatformType[]; - } - /** - * Third Party Authentication Token - */ - export interface Schema$ThirdPartyAuthenticationToken { - /** - * Name of the third-party authentication token. - */ - name?: string | null; - /** - * Value of the third-party authentication token. This is a read-only, auto-generated field. - */ - value?: string | null; - } - /** - * Third-party Tracking URL. - */ - export interface Schema$ThirdPartyTrackingUrl { - /** - * Third-party URL type for in-stream video and in-stream audio creatives. - */ - thirdPartyUrlType?: string | null; - /** - * URL for the specified third-party URL type. - */ - url?: string | null; - } - /** - * Transcode Settings - */ - export interface Schema$TranscodeSetting { - /** - * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. - */ - enabledVideoFormats?: number[] | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". - */ - kind?: string | null; - } - /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. - */ - export interface Schema$UniversalAdId { - /** - * Registry used for the Ad ID value. - */ - registry?: string | null; - /** - * ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. - */ - value?: string | null; - } - /** - * User Defined Variable configuration. - */ - export interface Schema$UserDefinedVariableConfiguration { - /** - * Data type for the variable. This is a required field. - */ - dataType?: string | null; - /** - * User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>". - */ - reportName?: string | null; - /** - * Variable name in the tag. This is a required field. - */ - variableType?: string | null; - } - /** - * Represents a UserProfile resource. - */ - export interface Schema$UserProfile { - /** - * The account ID to which this profile belongs. - */ - accountId?: string | null; - /** - * The account name this profile belongs to. - */ - accountName?: string | null; - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The kind of resource this is, in this case dfareporting#userProfile. - */ - kind?: string | null; - /** - * The unique ID of the user profile. - */ - profileId?: string | null; - /** - * The sub account ID this profile belongs to if applicable. - */ - subAccountId?: string | null; - /** - * The sub account name this profile belongs to if applicable. - */ - subAccountName?: string | null; - /** - * The user name. - */ - userName?: string | null; - } - /** - * Represents the list of user profiles. - */ - export interface Schema$UserProfileList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The user profiles returned in this response. - */ - items?: Schema$UserProfile[]; - /** - * The kind of list this is, in this case dfareporting#userProfileList. - */ - kind?: string | null; - } - /** - * Contains properties of auser role, which is used to manage user access. - */ - export interface Schema$UserRole { - /** - * Account ID of this user role. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. - */ - defaultUserRole?: boolean | null; - /** - * ID of this user role. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". - */ - kind?: string | null; - /** - * Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. - */ - name?: string | null; - /** - * ID of the user role that this user role is based on or copied from. This is a required field. - */ - parentUserRoleId?: string | null; - /** - * List of permissions associated with this user role. - */ - permissions?: Schema$UserRolePermission[]; - /** - * Subaccount ID of this user role. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Contains properties of a user role permission. - */ - export interface Schema$UserRolePermission { - /** - * Levels of availability for a user role permission. - */ - availability?: string | null; - /** - * ID of this user role permission. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". - */ - kind?: string | null; - /** - * Name of this user role permission. - */ - name?: string | null; - /** - * ID of the permission group that this user role permission belongs to. - */ - permissionGroupId?: string | null; - } - /** - * Represents a grouping of related user role permissions. - */ - export interface Schema$UserRolePermissionGroup { - /** - * ID of this user role permission. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". - */ - kind?: string | null; - /** - * Name of this user role permission group. - */ - name?: string | null; - } - /** - * User Role Permission Group List Response - */ - export interface Schema$UserRolePermissionGroupsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". - */ - kind?: string | null; - /** - * User role permission group collection. - */ - userRolePermissionGroups?: Schema$UserRolePermissionGroup[]; - } - /** - * User Role Permission List Response - */ - export interface Schema$UserRolePermissionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". - */ - kind?: string | null; - /** - * User role permission collection. - */ - userRolePermissions?: Schema$UserRolePermission[]; - } - /** - * User Role List Response - */ - export interface Schema$UserRolesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * User role collection. - */ - userRoles?: Schema$UserRole[]; - } - /** - * Contains information about supported video formats. - */ - export interface Schema$VideoFormat { - /** - * File type of the video format. - */ - fileType?: string | null; - /** - * ID of the video format. - */ - id?: number | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". - */ - kind?: string | null; - /** - * The resolution of this video format. - */ - resolution?: Schema$Size; - /** - * The target bit rate of this video format. - */ - targetBitRate?: number | null; - } - /** - * Video Format List Response - */ - export interface Schema$VideoFormatsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". - */ - kind?: string | null; - /** - * Video format collection. - */ - videoFormats?: Schema$VideoFormat[]; - } - /** - * Video Offset - */ - export interface Schema$VideoOffset { - /** - * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - */ - offsetPercentage?: number | null; - /** - * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. - */ - offsetSeconds?: number | null; - } - /** - * Video Settings - */ - export interface Schema$VideoSettings { - /** - * Settings for the companion creatives of video creatives served to this placement. - */ - companionSettings?: Schema$CompanionSetting; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". - */ - kind?: string | null; - /** - * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - */ - orientation?: string | null; - /** - * Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. - */ - skippableSettings?: Schema$SkippableSetting; - /** - * Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden. - */ - transcodeSettings?: Schema$TranscodeSetting; - } - - export class Resource$Accountactiveadsummaries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accountActiveAdSummaries.get - * @desc Gets the account's active ad summary by account ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account ID. - * summaryAccountId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountActiveAdSummaries.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountActiveAdSummaries.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.summaryAccountId Account 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$Accountactiveadsummaries$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accountactiveadsummaries$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accountactiveadsummaries$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Accountactiveadsummaries$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountactiveadsummaries$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountactiveadsummaries$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'summaryAccountId'], - pathParams: ['profileId', 'summaryAccountId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Accountactiveadsummaries$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Account ID. - */ - summaryAccountId?: string; - } - - export class Resource$Accountpermissiongroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accountPermissionGroups.get - * @desc Gets one account permission group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account permission group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountPermissionGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountPermissionGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account permission group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Accountpermissiongroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accountpermissiongroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accountpermissiongroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Accountpermissiongroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountpermissiongroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissiongroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountPermissionGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountPermissionGroups.list - * @desc Retrieves the list of account permission groups. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountPermissionGroups.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountPermissionGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Accountpermissiongroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accountpermissiongroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accountpermissiongroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Accountpermissiongroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$AccountPermissionGroupsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountpermissiongroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissiongroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountPermissionGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Accountpermissiongroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account permission group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountpermissiongroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Accountpermissions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accountPermissions.get - * @desc Gets one account permission by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account permission ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountPermissions.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountPermissions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account permission ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Accountpermissions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accountpermissions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accountpermissions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Accountpermissions$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountpermissions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountPermissions/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountPermissions.list - * @desc Retrieves the list of account permissions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountPermissions.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountPermissions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Accountpermissions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accountpermissions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accountpermissions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Accountpermissions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountpermissions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountPermissions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Accountpermissions$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account permission ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountpermissions$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Accounts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accounts.get - * @desc Gets one account by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accounts.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accounts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - 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://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accounts/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accounts.list - * @desc Retrieves the list of accounts, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var accountsPage = response['accounts']; - * if (!accountsPage) { - * return; - * } - * for (var i = 0; i < accountsPage.length; i++) { - * // TODO: Change code below to process each resource in `accountsPage`: - * console.log(JSON.stringify(accountsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.accounts.list(request, handlePage); - * } - * }; - * - * dfareporting.accounts.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accounts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active accounts. Don't set this field to select both active and non-active accounts. - * @param {string=} params.ids Select only accounts with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$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://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/accounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accounts.patch - * @desc Updates an existing account. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Account ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accounts.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accounts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Account} params.resource Request body data - * @param {object} [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$Accounts$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accounts$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Accounts$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/accounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accounts.update - * @desc Updates an existing account. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accounts.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accounts.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Account} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Accounts$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Accounts$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Accounts$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Accounts$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/accounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - 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; - - /** - * Account ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accounts$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active accounts. Don't set this field to select both active and non-active accounts. - */ - active?: boolean; - /** - * Select only accounts with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Accounts$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } - export interface Params$Resource$Accounts$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } - - export class Resource$Accountuserprofiles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accountUserProfiles.get - * @desc Gets one account user profile by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User profile ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.accountUserProfiles.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User profile ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Accountuserprofiles$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accountuserprofiles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accountuserprofiles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountUserProfiles/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountUserProfiles.insert - * @desc Inserts a new account user profile. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accountUserProfiles.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} params.resource Request body data - * @param {object} [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$Accountuserprofiles$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Accountuserprofiles$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Accountuserprofiles$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountUserProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountUserProfiles.list - * @desc Retrieves a list of account user profiles, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var accountUserProfilesPage = response['accountUserProfiles']; - * if (!accountUserProfilesPage) { - * return; - * } - * for (var i = 0; i < accountUserProfilesPage.length; i++) { - * // TODO: Change code below to process each resource in `accountUserProfilesPage`: - * console.log(JSON.stringify(accountUserProfilesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.accountUserProfiles.list(request, handlePage); - * } - * }; - * - * dfareporting.accountUserProfiles.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active user profiles. - * @param {string=} params.ids Select only user profiles with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only user profiles with the specified subaccount ID. - * @param {string=} params.userRoleId Select only user profiles with the specified user role 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$Accountuserprofiles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accountuserprofiles$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accountuserprofiles$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountUserProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.accountUserProfiles.patch - * @desc Updates an existing account user profile. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User profile ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accountUserProfiles.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User profile ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} params.resource Request body data - * @param {object} [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$Accountuserprofiles$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accountuserprofiles$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accountuserprofiles$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountUserProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountUserProfiles.update - * @desc Updates an existing account user profile. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.accountUserProfiles.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.accountUserProfiles.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} params.resource Request body data - * @param {object} [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$Accountuserprofiles$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Accountuserprofiles$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Accountuserprofiles$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/accountUserProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Accountuserprofiles$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountuserprofiles$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - export interface Params$Resource$Accountuserprofiles$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active user profiles. - */ - active?: boolean; - /** - * Select only user profiles with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only user profiles with the specified subaccount ID. - */ - subaccountId?: string; - /** - * Select only user profiles with the specified user role ID. - */ - userRoleId?: string; - } - export interface Params$Resource$Accountuserprofiles$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - export interface Params$Resource$Accountuserprofiles$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - - export class Resource$Ads { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.ads.get - * @desc Gets one ad by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Ad ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.ads.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Ad ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Ads$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Ads$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Ads$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Ads$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/ads/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.ads.insert - * @desc Inserts a new ad. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.ads.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} params.resource Request body data - * @param {object} [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$Ads$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Ads$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Ads$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Ads$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/ads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.ads.list - * @desc Retrieves a list of ads, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var adsPage = response['ads']; - * if (!adsPage) { - * return; - * } - * for (var i = 0; i < adsPage.length; i++) { - * // TODO: Change code below to process each resource in `adsPage`: - * console.log(JSON.stringify(adsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.ads.list(request, handlePage); - * } - * }; - * - * dfareporting.ads.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active ads. - * @param {string=} params.advertiserId Select only ads with this advertiser ID. - * @param {boolean=} params.archived Select only archived ads. - * @param {string=} params.audienceSegmentIds Select only ads with these audience segment IDs. - * @param {string=} params.campaignIds Select only ads with these campaign IDs. - * @param {string=} params.compatibility Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. - * @param {string=} params.creativeIds Select only ads with these creative IDs assigned. - * @param {string=} params.creativeOptimizationConfigurationIds Select only ads with these creative optimization configuration IDs. - * @param {boolean=} params.dynamicClickTracker Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. - * @param {string=} params.ids Select only ads with these IDs. - * @param {string=} params.landingPageIds Select only ads with these landing page IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.overriddenEventTagId Select only ads with this event tag override ID. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.placementIds Select only ads with these placement IDs assigned. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.remarketingListIds Select only ads whose list targeting expression use these remarketing list IDs. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". - * @param {string=} params.sizeIds Select only ads with these size IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {boolean=} params.sslCompliant Select only ads that are SSL-compliant. - * @param {boolean=} params.sslRequired Select only ads that require SSL. - * @param {string=} params.type Select only ads with these types. - * @param {object} [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$Ads$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Ads$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Ads$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Ads$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/ads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.ads.patch - * @desc Updates an existing ad. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Ad ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.ads.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Ad ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} params.resource Request body data - * @param {object} [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$Ads$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Ads$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Ads$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Ads$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/ads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.ads.update - * @desc Updates an existing ad. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.ads.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.ads.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} params.resource Request body data - * @param {object} [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$Ads$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Ads$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Ads$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Ads$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/ads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Ads$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Ad ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Ads$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - export interface Params$Resource$Ads$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active ads. - */ - active?: boolean; - /** - * Select only ads with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only archived ads. - */ - archived?: boolean; - /** - * Select only ads with these audience segment IDs. - */ - audienceSegmentIds?: string[]; - /** - * Select only ads with these campaign IDs. - */ - campaignIds?: string[]; - /** - * Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. - */ - compatibility?: string; - /** - * Select only ads with these creative IDs assigned. - */ - creativeIds?: string[]; - /** - * Select only ads with these creative optimization configuration IDs. - */ - creativeOptimizationConfigurationIds?: string[]; - /** - * Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. - */ - dynamicClickTracker?: boolean; - /** - * Select only ads with these IDs. - */ - ids?: string[]; - /** - * Select only ads with these landing page IDs. - */ - landingPageIds?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only ads with this event tag override ID. - */ - overriddenEventTagId?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only ads with these placement IDs assigned. - */ - placementIds?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only ads whose list targeting expression use these remarketing list IDs. - */ - remarketingListIds?: string[]; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". - */ - searchString?: string; - /** - * Select only ads with these size IDs. - */ - sizeIds?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only ads that are SSL-compliant. - */ - sslCompliant?: boolean; - /** - * Select only ads that require SSL. - */ - sslRequired?: boolean; - /** - * Select only ads with these types. - */ - type?: string[]; - } - export interface Params$Resource$Ads$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Ad ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - export interface Params$Resource$Ads$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - - export class Resource$Advertisergroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.advertiserGroups.delete - * @desc Deletes an existing advertiser group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Advertisergroups$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Advertisergroups$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Advertisergroups$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserGroups.get - * @desc Gets one advertiser group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Advertisergroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertisergroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertisergroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserGroups.insert - * @desc Inserts a new advertiser group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} params.resource Request body data - * @param {object} [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$Advertisergroups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Advertisergroups$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Advertisergroups$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserGroups.list - * @desc Retrieves a list of advertiser groups, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var advertiserGroupsPage = response['advertiserGroups']; - * if (!advertiserGroupsPage) { - * return; - * } - * for (var i = 0; i < advertiserGroupsPage.length; i++) { - * // TODO: Change code below to process each resource in `advertiserGroupsPage`: - * console.log(JSON.stringify(advertiserGroupsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.advertiserGroups.list(request, handlePage); - * } - * }; - * - * dfareporting.advertiserGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only advertiser groups with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Advertisergroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Advertisergroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisergroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Advertisergroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.advertiserGroups.patch - * @desc Updates an existing advertiser group. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser group ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} params.resource Request body data - * @param {object} [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$Advertisergroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Advertisergroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Advertisergroups$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserGroups.update - * @desc Updates an existing advertiser group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserGroups.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} params.resource Request body data - * @param {object} [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$Advertisergroups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Advertisergroups$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Advertisergroups$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Advertisergroups$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisergroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisergroups$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - export interface Params$Resource$Advertisergroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only advertiser groups with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Advertisergroups$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - export interface Params$Resource$Advertisergroups$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - - export class Resource$Advertiserlandingpages { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.advertiserLandingPages.get - * @desc Gets one landing page by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Landing page ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.advertiserLandingPages.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserLandingPages.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Landing page ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Advertiserlandingpages$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertiserlandingpages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertiserlandingpages$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserLandingPages/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserLandingPages.insert - * @desc Inserts a new landing page. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserLandingPages.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserLandingPages.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} params.resource Request body data - * @param {object} [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$Advertiserlandingpages$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Advertiserlandingpages$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Advertiserlandingpages$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserLandingPages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserLandingPages.list - * @desc Retrieves a list of landing pages. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var landingPagesPage = response['landingPages']; - * if (!landingPagesPage) { - * return; - * } - * for (var i = 0; i < landingPagesPage.length; i++) { - * // TODO: Change code below to process each resource in `landingPagesPage`: - * console.log(JSON.stringify(landingPagesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.advertiserLandingPages.list(request, handlePage); - * } - * }; - * - * dfareporting.advertiserLandingPages.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserLandingPages.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only landing pages that belong to these advertisers. - * @param {boolean=} params.archived Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. - * @param {string=} params.campaignIds Select only landing pages that are associated with these campaigns. - * @param {string=} params.ids Select only landing pages with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only landing pages that belong to this subaccount. - * @param {object} [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$Advertiserlandingpages$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Advertiserlandingpages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertiserlandingpages$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserLandingPages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.advertiserLandingPages.patch - * @desc Updates an existing landing page. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Landing page ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserLandingPages.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserLandingPages.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Landing page ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} params.resource Request body data - * @param {object} [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$Advertiserlandingpages$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Advertiserlandingpages$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Advertiserlandingpages$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserLandingPages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserLandingPages.update - * @desc Updates an existing landing page. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertiserLandingPages.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertiserLandingPages.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} params.resource Request body data - * @param {object} [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$Advertiserlandingpages$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Advertiserlandingpages$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Advertiserlandingpages$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertiserLandingPages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Advertiserlandingpages$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Landing page ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertiserlandingpages$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - export interface Params$Resource$Advertiserlandingpages$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only landing pages that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. - */ - archived?: boolean; - /** - * Select only landing pages that are associated with these campaigns. - */ - campaignIds?: string[]; - /** - * Select only landing pages with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only landing pages that belong to this subaccount. - */ - subaccountId?: string; - } - export interface Params$Resource$Advertiserlandingpages$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Landing page ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - export interface Params$Resource$Advertiserlandingpages$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - - export class Resource$Advertisers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.advertisers.get - * @desc Gets one advertiser by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.advertisers.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Advertisers$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertisers$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertisers$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Advertisers$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertisers/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertisers.insert - * @desc Inserts a new advertiser. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertisers.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} params.resource Request body data - * @param {object} [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$Advertisers$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Advertisers$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Advertisers$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Advertisers$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertisers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertisers.list - * @desc Retrieves a list of advertisers, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var advertisersPage = response['advertisers']; - * if (!advertisersPage) { - * return; - * } - * for (var i = 0; i < advertisersPage.length; i++) { - * // TODO: Change code below to process each resource in `advertisersPage`: - * console.log(JSON.stringify(advertisersPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.advertisers.list(request, handlePage); - * } - * }; - * - * dfareporting.advertisers.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserGroupIds Select only advertisers with these advertiser group IDs. - * @param {string=} params.floodlightConfigurationIds Select only advertisers with these floodlight configuration IDs. - * @param {string=} params.ids Select only advertisers with these IDs. - * @param {boolean=} params.includeAdvertisersWithoutGroupsOnly Select only advertisers which do not belong to any advertiser group. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {boolean=} params.onlyParent Select only advertisers which use another advertiser's floodlight configuration. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.status Select only advertisers with the specified status. - * @param {string=} params.subaccountId Select only advertisers with these subaccount IDs. - * @param {object} [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$Advertisers$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Advertisers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Advertisers$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertisers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertisers.patch - * @desc Updates an existing advertiser. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertisers.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} params.resource Request body data - * @param {object} [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$Advertisers$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Advertisers$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Advertisers$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Advertisers$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertisers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertisers.update - * @desc Updates an existing advertiser. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.advertisers.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.advertisers.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} params.resource Request body data - * @param {object} [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$Advertisers$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Advertisers$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Advertisers$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Advertisers$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/advertisers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Advertisers$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisers$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - export interface Params$Resource$Advertisers$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only advertisers with these advertiser group IDs. - */ - advertiserGroupIds?: string[]; - /** - * Select only advertisers with these floodlight configuration IDs. - */ - floodlightConfigurationIds?: string[]; - /** - * Select only advertisers with these IDs. - */ - ids?: string[]; - /** - * Select only advertisers which do not belong to any advertiser group. - */ - includeAdvertisersWithoutGroupsOnly?: boolean; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only advertisers which use another advertiser's floodlight configuration. - */ - onlyParent?: boolean; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only advertisers with the specified status. - */ - status?: string; - /** - * Select only advertisers with these subaccount IDs. - */ - subaccountId?: string; - } - export interface Params$Resource$Advertisers$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - export interface Params$Resource$Advertisers$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - - export class Resource$Browsers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.browsers.list - * @desc Retrieves a list of browsers. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.browsers.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.browsers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Browsers$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Browsers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Browsers$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Browsers$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Browsers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Browsers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/browsers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Browsers$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Campaigncreativeassociations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.campaignCreativeAssociations.insert - * @desc Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Campaign ID in this association. - * campaignId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.campaignCreativeAssociations.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaignCreativeAssociations.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Campaign ID in this association. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CampaignCreativeAssociation} params.resource Request body data - * @param {object} [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$Campaigncreativeassociations$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Campaigncreativeassociations$Insert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Campaigncreativeassociations$Insert, - callback: BodyResponseCallback - ): void; - insert( - callback: BodyResponseCallback - ): void; - insert( - paramsOrCallback?: - | Params$Resource$Campaigncreativeassociations$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Campaigncreativeassociations$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigncreativeassociations$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaignCreativeAssociations.list - * @desc Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Campaign ID in this association. - * campaignId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var campaignCreativeAssociationsPage = response['campaignCreativeAssociations']; - * if (!campaignCreativeAssociationsPage) { - * return; - * } - * for (var i = 0; i < campaignCreativeAssociationsPage.length; i++) { - * // TODO: Change code below to process each resource in `campaignCreativeAssociationsPage`: - * console.log(JSON.stringify(campaignCreativeAssociationsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.campaignCreativeAssociations.list(request, handlePage); - * } - * }; - * - * dfareporting.campaignCreativeAssociations.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaignCreativeAssociations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Campaign ID in this association. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Campaigncreativeassociations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Campaigncreativeassociations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse - > - ): void; - list( - params: Params$Resource$Campaigncreativeassociations$List, - callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Campaigncreativeassociations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Campaigncreativeassociations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigncreativeassociations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$CampaignCreativeAssociationsListResponse - >(parameters); - } - } - } - - export interface Params$Resource$Campaigncreativeassociations$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Campaign ID in this association. - */ - campaignId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CampaignCreativeAssociation; - } - export interface Params$Resource$Campaigncreativeassociations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Campaign ID in this association. - */ - campaignId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Campaigns { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.campaigns.get - * @desc Gets one campaign by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Campaign ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.campaigns.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Campaign ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Campaigns$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Campaigns$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Campaigns$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Campaigns$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/campaigns/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaigns.insert - * @desc Inserts a new campaign. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.campaigns.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} params.resource Request body data - * @param {object} [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$Campaigns$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Campaigns$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Campaigns$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Campaigns$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/campaigns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaigns.list - * @desc Retrieves a list of campaigns, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var campaignsPage = response['campaigns']; - * if (!campaignsPage) { - * return; - * } - * for (var i = 0; i < campaignsPage.length; i++) { - * // TODO: Change code below to process each resource in `campaignsPage`: - * console.log(JSON.stringify(campaignsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.campaigns.list(request, handlePage); - * } - * }; - * - * dfareporting.campaigns.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups. - * @param {string=} params.advertiserIds Select only campaigns that belong to these advertisers. - * @param {boolean=} params.archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. - * @param {boolean=} params.atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity. - * @param {string=} params.excludedIds Exclude campaigns with these IDs. - * @param {string=} params.ids Select only campaigns with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.overriddenEventTagId Select only campaigns that have overridden this event tag ID. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only campaigns that belong to this subaccount. - * @param {object} [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$Campaigns$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Campaigns$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Campaigns$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Campaigns$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/campaigns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaigns.patch - * @desc Updates an existing campaign. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Campaign ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.campaigns.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Campaign ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} params.resource Request body data - * @param {object} [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$Campaigns$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Campaigns$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Campaigns$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Campaigns$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/campaigns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaigns.update - * @desc Updates an existing campaign. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.campaigns.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.campaigns.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} params.resource Request body data - * @param {object} [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$Campaigns$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Campaigns$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Campaigns$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Campaigns$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/campaigns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Campaigns$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Campaign ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Campaigns$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - export interface Params$Resource$Campaigns$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only campaigns whose advertisers belong to these advertiser groups. - */ - advertiserGroupIds?: string[]; - /** - * Select only campaigns that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. - */ - archived?: boolean; - /** - * Select only campaigns that have at least one optimization activity. - */ - atLeastOneOptimizationActivity?: boolean; - /** - * Exclude campaigns with these IDs. - */ - excludedIds?: string[]; - /** - * Select only campaigns with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only campaigns that have overridden this event tag ID. - */ - overriddenEventTagId?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only campaigns that belong to this subaccount. - */ - subaccountId?: string; - } - export interface Params$Resource$Campaigns$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Campaign ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - export interface Params$Resource$Campaigns$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - - export class Resource$Changelogs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.changeLogs.get - * @desc Gets one change log by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Change log ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.changeLogs.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.changeLogs.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Change log ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Changelogs$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Changelogs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Changelogs$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Changelogs$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Changelogs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/changeLogs/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.changeLogs.list - * @desc Retrieves a list of change logs. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var changeLogsPage = response['changeLogs']; - * if (!changeLogsPage) { - * return; - * } - * for (var i = 0; i < changeLogsPage.length; i++) { - * // TODO: Change code below to process each resource in `changeLogsPage`: - * console.log(JSON.stringify(changeLogsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.changeLogs.list(request, handlePage); - * } - * }; - * - * dfareporting.changeLogs.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.changeLogs.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.action Select only change logs with the specified action. - * @param {string=} params.ids Select only change logs with these IDs. - * @param {string=} params.maxChangeTime Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.minChangeTime Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - * @param {string=} params.objectIds Select only change logs with these object IDs. - * @param {string=} params.objectType Select only change logs with the specified object type. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Select only change logs whose object ID, user name, old or new values match the search string. - * @param {string=} params.userProfileIds Select only change logs with these user profile IDs. - * @param {object} [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$Changelogs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Changelogs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Changelogs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Changelogs$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Changelogs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/changeLogs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Changelogs$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Change log ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Changelogs$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only change logs with the specified action. - */ - action?: string; - /** - * Select only change logs with these IDs. - */ - ids?: string[]; - /** - * Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - */ - maxChangeTime?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - */ - minChangeTime?: string; - /** - * Select only change logs with these object IDs. - */ - objectIds?: string[]; - /** - * Select only change logs with the specified object type. - */ - objectType?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only change logs whose object ID, user name, old or new values match the search string. - */ - searchString?: string; - /** - * Select only change logs with these user profile IDs. - */ - userProfileIds?: string[]; - } - - export class Resource$Cities { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.cities.list - * @desc Retrieves a list of cities, possibly filtered. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.cities.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.cities.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.countryDartIds Select only cities from these countries. - * @param {string=} params.dartIds Select only cities with these DART IDs. - * @param {string=} params.namePrefix Select only cities with names starting with this prefix. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.regionDartIds Select only cities from these regions. - * @param {object} [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$Cities$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Cities$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Cities$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Cities$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Cities$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Cities$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/cities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Cities$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only cities from these countries. - */ - countryDartIds?: string[]; - /** - * Select only cities with these DART IDs. - */ - dartIds?: string[]; - /** - * Select only cities with names starting with this prefix. - */ - namePrefix?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only cities from these regions. - */ - regionDartIds?: string[]; - } - - export class Resource$Connectiontypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.connectionTypes.get - * @desc Gets one connection type by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Connection type ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.connectionTypes.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.connectionTypes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Connection type ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Connectiontypes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Connectiontypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Connectiontypes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Connectiontypes$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Connectiontypes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Connectiontypes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/connectionTypes/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.connectionTypes.list - * @desc Retrieves a list of connection types. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.connectionTypes.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.connectionTypes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Connectiontypes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Connectiontypes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Connectiontypes$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Connectiontypes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Connectiontypes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Connectiontypes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/connectionTypes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Connectiontypes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Connection type ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Connectiontypes$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Contentcategories { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.contentCategories.delete - * @desc Deletes an existing content category. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Content category ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Contentcategories$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Contentcategories$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Contentcategories$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Contentcategories$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/contentCategories/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.contentCategories.get - * @desc Gets one content category by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Content category ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Contentcategories$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Contentcategories$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Contentcategories$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Contentcategories$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/contentCategories/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.contentCategories.insert - * @desc Inserts a new content category. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} params.resource Request body data - * @param {object} [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$Contentcategories$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Contentcategories$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Contentcategories$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Contentcategories$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/contentCategories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.contentCategories.list - * @desc Retrieves a list of content categories, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var contentCategoriesPage = response['contentCategories']; - * if (!contentCategoriesPage) { - * return; - * } - * for (var i = 0; i < contentCategoriesPage.length; i++) { - * // TODO: Change code below to process each resource in `contentCategoriesPage`: - * console.log(JSON.stringify(contentCategoriesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.contentCategories.list(request, handlePage); - * } - * }; - * - * dfareporting.contentCategories.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only content categories with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Contentcategories$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Contentcategories$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Contentcategories$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Contentcategories$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/contentCategories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.contentCategories.patch - * @desc Updates an existing content category. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Content category ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} params.resource Request body data - * @param {object} [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$Contentcategories$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Contentcategories$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Contentcategories$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Contentcategories$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/contentCategories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.contentCategories.update - * @desc Updates an existing content category. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.contentCategories.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.contentCategories.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} params.resource Request body data - * @param {object} [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$Contentcategories$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Contentcategories$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Contentcategories$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Contentcategories$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/contentCategories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Contentcategories$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Contentcategories$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Contentcategories$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - export interface Params$Resource$Contentcategories$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only content categories with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Contentcategories$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - export interface Params$Resource$Contentcategories$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - - export class Resource$Conversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.conversions.batchinsert - * @desc Inserts conversions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.conversions.batchinsert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/ddmconversions' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.conversions.batchinsert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ConversionsBatchInsertRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - batchinsert( - params?: Params$Resource$Conversions$Batchinsert, - options?: MethodOptions - ): GaxiosPromise; - batchinsert( - params: Params$Resource$Conversions$Batchinsert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchinsert( - params: Params$Resource$Conversions$Batchinsert, - callback: BodyResponseCallback - ): void; - batchinsert( - callback: BodyResponseCallback - ): void; - batchinsert( - paramsOrCallback?: - | Params$Resource$Conversions$Batchinsert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Conversions$Batchinsert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Conversions$Batchinsert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/conversions/batchinsert' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.conversions.batchupdate - * @desc Updates existing conversions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.conversions.batchupdate(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/ddmconversions' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.conversions.batchupdate - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ConversionsBatchUpdateRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - batchupdate( - params?: Params$Resource$Conversions$Batchupdate, - options?: MethodOptions - ): GaxiosPromise; - batchupdate( - params: Params$Resource$Conversions$Batchupdate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchupdate( - params: Params$Resource$Conversions$Batchupdate, - callback: BodyResponseCallback - ): void; - batchupdate( - callback: BodyResponseCallback - ): void; - batchupdate( - paramsOrCallback?: - | Params$Resource$Conversions$Batchupdate - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Conversions$Batchupdate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Conversions$Batchupdate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/conversions/batchupdate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Conversions$Batchinsert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ConversionsBatchInsertRequest; - } - export interface Params$Resource$Conversions$Batchupdate - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ConversionsBatchUpdateRequest; - } - - export class Resource$Countries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.countries.get - * @desc Gets one country by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Country DART ID. - * dartId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.countries.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.countries.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dartId Country DART ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Countries$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Countries$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Countries$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Countries$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Countries$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Countries$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/countries/{dartId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'dartId'], - pathParams: ['dartId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.countries.list - * @desc Retrieves a list of countries. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.countries.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.countries.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Countries$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Countries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Countries$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Countries$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Countries$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Countries$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/countries' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Countries$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Country DART ID. - */ - dartId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Countries$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Creativeassets { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creativeAssets.insert - * @desc Inserts a new creative asset. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Advertiser ID of this creative. This is a required field. - * advertiserId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * media: { - * // TODO: Add desired media content for upload. See - * // https://github.com/google/google-api-nodejs-client#media-uploads - * mimeType: '', // See https://www.w3.org/Protocols/rfc1341/4_Content-Type.html - * body: '', - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeAssets.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeAssets.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.advertiserId Advertiser ID of this creative. This is a required field. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} params.resource Media resource metadata - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Creativeassets$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creativeassets$Insert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creativeassets$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creativeassets$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativeassets$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativeassets$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - mediaUrl: ( - rootUrl + - '/upload/dfareporting/v3.1/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['advertiserId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativeassets$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser ID of this creative. This is a required field. - */ - advertiserId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeAssetMetadata; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - - export class Resource$Creativefields { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creativeFields.delete - * @desc Deletes an existing creative field. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative Field ID - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Creativefields$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Creativefields$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Creativefields$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Creativefields$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.get - * @desc Gets one creative field by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative Field ID - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Creativefields$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Creativefields$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Creativefields$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Creativefields$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.insert - * @desc Inserts a new creative field. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} params.resource Request body data - * @param {object} [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$Creativefields$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creativefields$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creativefields$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creativefields$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.list - * @desc Retrieves a list of creative fields, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var creativeFieldsPage = response['creativeFields']; - * if (!creativeFieldsPage) { - * return; - * } - * for (var i = 0; i < creativeFieldsPage.length; i++) { - * // TODO: Change code below to process each resource in `creativeFieldsPage`: - * console.log(JSON.stringify(creativeFieldsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.creativeFields.list(request, handlePage); - * } - * }; - * - * dfareporting.creativeFields.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only creative fields that belong to these advertisers. - * @param {string=} params.ids Select only creative fields with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Creativefields$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Creativefields$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Creativefields$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Creativefields$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.patch - * @desc Updates an existing creative field. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative Field ID - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} params.resource Request body data - * @param {object} [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$Creativefields$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Creativefields$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Creativefields$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Creativefields$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.update - * @desc Updates an existing creative field. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFields.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFields.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} params.resource Request body data - * @param {object} [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$Creativefields$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Creativefields$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Creativefields$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Creativefields$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativefields$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefields$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefields$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - export interface Params$Resource$Creativefields$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only creative fields that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only creative fields with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativefields$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - export interface Params$Resource$Creativefields$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - - export class Resource$Creativefieldvalues { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creativeFieldValues.delete - * @desc Deletes an existing creative field value. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * // Creative Field Value ID - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Creativefieldvalues$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Creativefieldvalues$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Creativefieldvalues$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFieldValues.get - * @desc Gets one creative field value by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * // Creative Field Value ID - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Creativefieldvalues$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Creativefieldvalues$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Creativefieldvalues$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFieldValues.insert - * @desc Inserts a new creative field value. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} params.resource Request body data - * @param {object} [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$Creativefieldvalues$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creativefieldvalues$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creativefieldvalues$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFieldValues.list - * @desc Retrieves a list of creative field values, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var creativeFieldValuesPage = response['creativeFieldValues']; - * if (!creativeFieldValuesPage) { - * return; - * } - * for (var i = 0; i < creativeFieldValuesPage.length; i++) { - * // TODO: Change code below to process each resource in `creativeFieldValuesPage`: - * console.log(JSON.stringify(creativeFieldValuesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.creativeFieldValues.list(request, handlePage); - * } - * }; - * - * dfareporting.creativeFieldValues.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string=} params.ids Select only creative field values with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Creativefieldvalues$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Creativefieldvalues$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Creativefieldvalues$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.creativeFieldValues.patch - * @desc Updates an existing creative field value. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * // Creative Field Value ID - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} params.resource Request body data - * @param {object} [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$Creativefieldvalues$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Creativefieldvalues$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Creativefieldvalues$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFieldValues.update - * @desc Updates an existing creative field value. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative field ID for this creative field value. - * creativeFieldId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeFieldValues.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeFieldValues.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} params.resource Request body data - * @param {object} [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$Creativefieldvalues$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Creativefieldvalues$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Creativefieldvalues$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativefieldvalues$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefieldvalues$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefieldvalues$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - export interface Params$Resource$Creativefieldvalues$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Select only creative field values with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativefieldvalues$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - export interface Params$Resource$Creativefieldvalues$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - - export class Resource$Creativegroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creativeGroups.get - * @desc Gets one creative group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creativeGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Creativegroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Creativegroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Creativegroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Creativegroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeGroups.insert - * @desc Inserts a new creative group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeGroups.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} params.resource Request body data - * @param {object} [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$Creativegroups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creativegroups$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creativegroups$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creativegroups$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeGroups.list - * @desc Retrieves a list of creative groups, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var creativeGroupsPage = response['creativeGroups']; - * if (!creativeGroupsPage) { - * return; - * } - * for (var i = 0; i < creativeGroupsPage.length; i++) { - * // TODO: Change code below to process each resource in `creativeGroupsPage`: - * console.log(JSON.stringify(creativeGroupsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.creativeGroups.list(request, handlePage); - * } - * }; - * - * dfareporting.creativeGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only creative groups that belong to these advertisers. - * @param {integer=} params.groupNumber Select only creative groups that belong to this subgroup. - * @param {string=} params.ids Select only creative groups with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Creativegroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Creativegroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Creativegroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Creativegroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeGroups.patch - * @desc Updates an existing creative group. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative group ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeGroups.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} params.resource Request body data - * @param {object} [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$Creativegroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Creativegroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Creativegroups$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Creativegroups$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeGroups.update - * @desc Updates an existing creative group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creativeGroups.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creativeGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} params.resource Request body data - * @param {object} [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$Creativegroups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Creativegroups$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Creativegroups$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Creativegroups$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creativeGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativegroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativegroups$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - export interface Params$Resource$Creativegroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only creative groups that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only creative groups that belong to this subgroup. - */ - groupNumber?: number; - /** - * Select only creative groups with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativegroups$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - export interface Params$Resource$Creativegroups$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - - export class Resource$Creatives { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creatives.get - * @desc Gets one creative by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.creatives.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Creatives$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Creatives$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Creatives$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Creatives$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/creatives/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creatives.insert - * @desc Inserts a new creative. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creatives.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} params.resource Request body data - * @param {object} [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$Creatives$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creatives$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creatives$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creatives$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creatives.list - * @desc Retrieves a list of creatives, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var creativesPage = response['creatives']; - * if (!creativesPage) { - * return; - * } - * for (var i = 0; i < creativesPage.length; i++) { - * // TODO: Change code below to process each resource in `creativesPage`: - * console.log(JSON.stringify(creativesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.creatives.list(request, handlePage); - * } - * }; - * - * dfareporting.creatives.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active creatives. Leave blank to select active and inactive creatives. - * @param {string=} params.advertiserId Select only creatives with this advertiser ID. - * @param {boolean=} params.archived Select only archived creatives. Leave blank to select archived and unarchived creatives. - * @param {string=} params.campaignId Select only creatives with this campaign ID. - * @param {string=} params.companionCreativeIds Select only in-stream video creatives with these companion IDs. - * @param {string=} params.creativeFieldIds Select only creatives with these creative field IDs. - * @param {string=} params.ids Select only creatives with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.renderingIds Select only creatives with these rendering IDs. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". - * @param {string=} params.sizeIds Select only creatives with these size IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.studioCreativeId Select only creatives corresponding to this Studio creative ID. - * @param {string=} params.types Select only creatives with these creative types. - * @param {object} [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$Creatives$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Creatives$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Creatives$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Creatives$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creatives.patch - * @desc Updates an existing creative. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Creative ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creatives.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} params.resource Request body data - * @param {object} [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$Creatives$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Creatives$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Creatives$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Creatives$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creatives.update - * @desc Updates an existing creative. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.creatives.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.creatives.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} params.resource Request body data - * @param {object} [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$Creatives$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Creatives$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Creatives$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Creatives$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creatives$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creatives$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - export interface Params$Resource$Creatives$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active creatives. Leave blank to select active and inactive creatives. - */ - active?: boolean; - /** - * Select only creatives with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only archived creatives. Leave blank to select archived and unarchived creatives. - */ - archived?: boolean; - /** - * Select only creatives with this campaign ID. - */ - campaignId?: string; - /** - * Select only in-stream video creatives with these companion IDs. - */ - companionCreativeIds?: string[]; - /** - * Select only creatives with these creative field IDs. - */ - creativeFieldIds?: string[]; - /** - * Select only creatives with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only creatives with these rendering IDs. - */ - renderingIds?: string[]; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". - */ - searchString?: string; - /** - * Select only creatives with these size IDs. - */ - sizeIds?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only creatives corresponding to this Studio creative ID. - */ - studioCreativeId?: string; - /** - * Select only creatives with these creative types. - */ - types?: string[]; - } - export interface Params$Resource$Creatives$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - export interface Params$Resource$Creatives$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - - export class Resource$Dimensionvalues { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.dimensionValues.query - * @desc Retrieves list of report dimension values for a list of filters. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.dimensionValues.query(request, handlePage); - * } - * }; - * - * dfareporting.dimensionValues.query(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.dimensionValues.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA user profile ID. - * @param {().DimensionValueRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - query( - params?: Params$Resource$Dimensionvalues$Query, - options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Dimensionvalues$Query, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Dimensionvalues$Query, - callback: BodyResponseCallback - ): void; - query(callback: BodyResponseCallback): void; - query( - paramsOrCallback?: - | Params$Resource$Dimensionvalues$Query - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Dimensionvalues$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dimensionvalues$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/dimensionvalues/query' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Dimensionvalues$Query - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DimensionValueRequest; - } - - export class Resource$Directorysites { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.directorySites.get - * @desc Gets one directory site by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Directory site ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.directorySites.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.directorySites.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Directory site ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Directorysites$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Directorysites$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Directorysites$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Directorysites$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Directorysites$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/directorySites/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.directorySites.insert - * @desc Inserts a new directory site. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.directorySites.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.directorySites.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().DirectorySite} params.resource Request body data - * @param {object} [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$Directorysites$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Directorysites$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Directorysites$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Directorysites$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Directorysites$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/directorySites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.directorySites.list - * @desc Retrieves a list of directory sites, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var directorySitesPage = response['directorySites']; - * if (!directorySitesPage) { - * return; - * } - * for (var i = 0; i < directorySitesPage.length; i++) { - * // TODO: Change code below to process each resource in `directorySitesPage`: - * console.log(JSON.stringify(directorySitesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.directorySites.list(request, handlePage); - * } - * }; - * - * dfareporting.directorySites.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.directorySites.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsPublisherPaidPlacements Select only directory sites that accept publisher paid placements. This field can be left blank. - * @param {boolean=} params.active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. - * @param {string=} params.dfpNetworkCode Select only directory sites with this Ad Manager network code. - * @param {string=} params.ids Select only directory sites with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Directorysites$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Directorysites$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Directorysites$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Directorysites$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Directorysites$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/directorySites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Directorysites$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Directory site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Directorysites$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DirectorySite; - } - export interface Params$Resource$Directorysites$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * This search filter is no longer supported and will have no effect on the results returned. - */ - acceptsInStreamVideoPlacements?: boolean; - /** - * This search filter is no longer supported and will have no effect on the results returned. - */ - acceptsInterstitialPlacements?: boolean; - /** - * Select only directory sites that accept publisher paid placements. This field can be left blank. - */ - acceptsPublisherPaidPlacements?: boolean; - /** - * Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. - */ - active?: boolean; - /** - * Select only directory sites with this Ad Manager network code. - */ - dfpNetworkCode?: string; - /** - * Select only directory sites with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Dynamictargetingkeys { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.dynamicTargetingKeys.delete - * @desc Deletes an existing dynamic targeting key. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // ID of the object of this dynamic targeting key. This is a required field. - * objectId: '0', // TODO: Update placeholder value. - * - * // Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long - * // and cannot contain commas. All characters are converted to lowercase. - * name: '', // TODO: Update placeholder value. - * - * // Type of the object of this dynamic targeting key. This is a required field. - * objectType: '', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.dynamicTargetingKeys.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.dynamicTargetingKeys.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. - * @param {string} params.objectId ID of the object of this dynamic targeting key. This is a required field. - * @param {string} params.objectType Type of the object of this dynamic targeting key. This is a required field. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Dynamictargetingkeys$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Dynamictargetingkeys$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Dynamictargetingkeys$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Dynamictargetingkeys$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Dynamictargetingkeys$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'objectId', 'name', 'objectType'], - pathParams: ['objectId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.dynamicTargetingKeys.insert - * @desc Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.dynamicTargetingKeys.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.dynamicTargetingKeys.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().DynamicTargetingKey} params.resource Request body data - * @param {object} [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$Dynamictargetingkeys$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Dynamictargetingkeys$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Dynamictargetingkeys$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Dynamictargetingkeys$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Dynamictargetingkeys$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/dynamicTargetingKeys' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.dynamicTargetingKeys.list - * @desc Retrieves a list of dynamic targeting keys. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.dynamicTargetingKeys.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.dynamicTargetingKeys.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only dynamic targeting keys whose object has this advertiser ID. - * @param {string=} params.names Select only dynamic targeting keys exactly matching these names. - * @param {string=} params.objectId Select only dynamic targeting keys with this object ID. - * @param {string=} params.objectType Select only dynamic targeting keys with this object type. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Dynamictargetingkeys$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Dynamictargetingkeys$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Dynamictargetingkeys$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Dynamictargetingkeys$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Dynamictargetingkeys$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/dynamicTargetingKeys' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Dynamictargetingkeys$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. - */ - name?: string; - /** - * ID of the object of this dynamic targeting key. This is a required field. - */ - objectId?: string; - /** - * Type of the object of this dynamic targeting key. This is a required field. - */ - objectType?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Dynamictargetingkeys$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DynamicTargetingKey; - } - export interface Params$Resource$Dynamictargetingkeys$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only dynamic targeting keys whose object has this advertiser ID. - */ - advertiserId?: string; - /** - * Select only dynamic targeting keys exactly matching these names. - */ - names?: string[]; - /** - * Select only dynamic targeting keys with this object ID. - */ - objectId?: string; - /** - * Select only dynamic targeting keys with this object type. - */ - objectType?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Eventtags { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.eventTags.delete - * @desc Deletes an existing event tag. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Event tag ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Eventtags$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Eventtags$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Eventtags$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Eventtags$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/eventTags/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.get - * @desc Gets one event tag by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Event tag ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Eventtags$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Eventtags$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Eventtags$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Eventtags$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/eventTags/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.insert - * @desc Inserts a new event tag. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} params.resource Request body data - * @param {object} [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$Eventtags$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Eventtags$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Eventtags$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Eventtags$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/eventTags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.list - * @desc Retrieves a list of event tags, possibly filtered. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.adId Select only event tags that belong to this ad. - * @param {string=} params.advertiserId Select only event tags that belong to this advertiser. - * @param {string=} params.campaignId Select only event tags that belong to this campaign. - * @param {boolean=} params.definitionsOnly Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. - * @param {boolean=} params.enabled Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. - * @param {string=} params.eventTagTypes Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. - * @param {string=} params.ids Select only event tags with these IDs. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Eventtags$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Eventtags$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Eventtags$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Eventtags$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/eventTags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.patch - * @desc Updates an existing event tag. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Event tag ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} params.resource Request body data - * @param {object} [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$Eventtags$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Eventtags$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Eventtags$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Eventtags$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/eventTags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.update - * @desc Updates an existing event tag. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.eventTags.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.eventTags.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} params.resource Request body data - * @param {object} [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$Eventtags$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Eventtags$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Eventtags$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Eventtags$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/eventTags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Eventtags$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Eventtags$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Eventtags$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - export interface Params$Resource$Eventtags$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only event tags that belong to this ad. - */ - adId?: string; - /** - * Select only event tags that belong to this advertiser. - */ - advertiserId?: string; - /** - * Select only event tags that belong to this campaign. - */ - campaignId?: string; - /** - * Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. - */ - definitionsOnly?: boolean; - /** - * Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. - */ - enabled?: boolean; - /** - * Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. - */ - eventTagTypes?: string[]; - /** - * Select only event tags with these IDs. - */ - ids?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Eventtags$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - export interface Params$Resource$Eventtags$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - - export class Resource$Files { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.files.get - * @desc Retrieves a report file by its report ID and file ID. This method supports media download. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * // The ID of the report file. - * fileId: '0', // TODO: Update placeholder value. - * - * // TODO: To download media content, use: - * // - * // alt: 'media', - * - * auth: authClient, - * }; - * - * dfareporting.files.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.files.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the report file. - * @param {string} params.reportId The ID of the report. - * @param {object} [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$Files$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Files$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Files$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Files$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Files$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/reports/{reportId}/files/{fileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['reportId', 'fileId'], - pathParams: ['fileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.files.list - * @desc Lists files for a user profile. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.files.list(request, handlePage); - * } - * }; - * - * dfareporting.files.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.files.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA profile ID. - * @param {string=} params.scope The scope that defines which results are returned. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Files$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Files$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Files$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Files$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Files$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/files' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Files$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the report file. - */ - fileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Files$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The scope that defines which results are returned. - */ - scope?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Floodlightactivities { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.floodlightActivities.delete - * @desc Deletes an existing floodlight activity. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Floodlightactivities$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Floodlightactivities$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Floodlightactivities$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivities/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivities.generatetag - * @desc Generates a tag for a floodlight activity. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.generatetag(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.generatetag - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.floodlightActivityId Floodlight activity ID for which we want to generate a tag. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - generatetag( - params?: Params$Resource$Floodlightactivities$Generatetag, - options?: MethodOptions - ): GaxiosPromise; - generatetag( - params: Params$Resource$Floodlightactivities$Generatetag, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse - > - ): void; - generatetag( - params: Params$Resource$Floodlightactivities$Generatetag, - callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse - > - ): void; - generatetag( - callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse - > - ): void; - generatetag( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Generatetag - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Generatetag; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Generatetag; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivities/generatetag' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.floodlightActivities.get - * @desc Gets one floodlight activity by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Floodlightactivities$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Floodlightactivities$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Floodlightactivities$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivities/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivities.insert - * @desc Inserts a new floodlight activity. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} params.resource Request body data - * @param {object} [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$Floodlightactivities$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Floodlightactivities$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Floodlightactivities$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivities.list - * @desc Retrieves a list of floodlight activities, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var floodlightActivitiesPage = response['floodlightActivities']; - * if (!floodlightActivitiesPage) { - * return; - * } - * for (var i = 0; i < floodlightActivitiesPage.length; i++) { - * // TODO: Change code below to process each resource in `floodlightActivitiesPage`: - * console.log(JSON.stringify(floodlightActivitiesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.floodlightActivities.list(request, handlePage); - * } - * }; - * - * dfareporting.floodlightActivities.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs. - * @param {string=} params.floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name. - * @param {string=} params.floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string. - * @param {string=} params.floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type. - * @param {string=} params.floodlightConfigurationId Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.ids Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.tagString Select only floodlight activities with the specified tag string. - * @param {object} [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$Floodlightactivities$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Floodlightactivities$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Floodlightactivities$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.floodlightActivities.patch - * @desc Updates an existing floodlight activity. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} params.resource Request body data - * @param {object} [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$Floodlightactivities$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Floodlightactivities$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Floodlightactivities$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivities.update - * @desc Updates an existing floodlight activity. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivities.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivities.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} params.resource Request body data - * @param {object} [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$Floodlightactivities$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Floodlightactivities$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Floodlightactivities$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightactivities$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Generatetag - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity ID for which we want to generate a tag. - */ - floodlightActivityId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - export interface Params$Resource$Floodlightactivities$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - */ - advertiserId?: string; - /** - * Select only floodlight activities with the specified floodlight activity group IDs. - */ - floodlightActivityGroupIds?: string[]; - /** - * Select only floodlight activities with the specified floodlight activity group name. - */ - floodlightActivityGroupName?: string; - /** - * Select only floodlight activities with the specified floodlight activity group tag string. - */ - floodlightActivityGroupTagString?: string; - /** - * Select only floodlight activities with the specified floodlight activity group type. - */ - floodlightActivityGroupType?: string; - /** - * Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - */ - floodlightConfigurationId?: string; - /** - * Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only floodlight activities with the specified tag string. - */ - tagString?: string; - } - export interface Params$Resource$Floodlightactivities$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - export interface Params$Resource$Floodlightactivities$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - - export class Resource$Floodlightactivitygroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.floodlightActivityGroups.get - * @desc Gets one floodlight activity group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity Group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivityGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity Group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Floodlightactivitygroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Floodlightactivitygroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Floodlightactivitygroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivityGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivityGroups.insert - * @desc Inserts a new floodlight activity group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivityGroups.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} params.resource Request body data - * @param {object} [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$Floodlightactivitygroups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Floodlightactivitygroups$Insert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Floodlightactivitygroups$Insert, - callback: BodyResponseCallback - ): void; - insert( - callback: BodyResponseCallback - ): void; - insert( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivityGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivityGroups.list - * @desc Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var floodlightActivityGroupsPage = response['floodlightActivityGroups']; - * if (!floodlightActivityGroupsPage) { - * return; - * } - * for (var i = 0; i < floodlightActivityGroupsPage.length; i++) { - * // TODO: Change code below to process each resource in `floodlightActivityGroupsPage`: - * console.log(JSON.stringify(floodlightActivityGroupsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.floodlightActivityGroups.list(request, handlePage); - * } - * }; - * - * dfareporting.floodlightActivityGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - * @param {string=} params.floodlightConfigurationId Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.ids Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.type Select only floodlight activity groups with the specified floodlight activity group 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 - */ - list( - params?: Params$Resource$Floodlightactivitygroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Floodlightactivitygroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$FloodlightActivityGroupsListResponse - > - ): void; - list( - params: Params$Resource$Floodlightactivitygroups$List, - callback: BodyResponseCallback< - Schema$FloodlightActivityGroupsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$FloodlightActivityGroupsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$FloodlightActivityGroupsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivityGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.floodlightActivityGroups.patch - * @desc Updates an existing floodlight activity group. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight activity Group ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivityGroups.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity Group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} params.resource Request body data - * @param {object} [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$Floodlightactivitygroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Floodlightactivitygroups$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Floodlightactivitygroups$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivityGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivityGroups.update - * @desc Updates an existing floodlight activity group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightActivityGroups.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightActivityGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} params.resource Request body data - * @param {object} [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$Floodlightactivitygroups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Floodlightactivitygroups$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Floodlightactivitygroups$Update, - callback: BodyResponseCallback - ): void; - update( - callback: BodyResponseCallback - ): void; - update( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightActivityGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightactivitygroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity Group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivitygroups$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - export interface Params$Resource$Floodlightactivitygroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - */ - advertiserId?: string; - /** - * Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. - */ - floodlightConfigurationId?: string; - /** - * Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only floodlight activity groups with the specified floodlight activity group type. - */ - type?: string; - } - export interface Params$Resource$Floodlightactivitygroups$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity Group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - export interface Params$Resource$Floodlightactivitygroups$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - - export class Resource$Floodlightconfigurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.floodlightConfigurations.get - * @desc Gets one floodlight configuration by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight configuration ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightConfigurations.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightConfigurations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight configuration ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Floodlightconfigurations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Floodlightconfigurations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Floodlightconfigurations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Floodlightconfigurations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightconfigurations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightConfigurations/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightConfigurations.list - * @desc Retrieves a list of floodlight configurations, possibly filtered. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.floodlightConfigurations.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightConfigurations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Floodlightconfigurations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Floodlightconfigurations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$FloodlightConfigurationsListResponse - > - ): void; - list( - params: Params$Resource$Floodlightconfigurations$List, - callback: BodyResponseCallback< - Schema$FloodlightConfigurationsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$FloodlightConfigurationsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Floodlightconfigurations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$FloodlightConfigurationsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightconfigurations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightConfigurations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.floodlightConfigurations.patch - * @desc Updates an existing floodlight configuration. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Floodlight configuration ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightConfigurations.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightConfigurations.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight configuration ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightConfiguration} params.resource Request body data - * @param {object} [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$Floodlightconfigurations$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Floodlightconfigurations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Floodlightconfigurations$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Floodlightconfigurations$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightconfigurations$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightConfigurations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightConfigurations.update - * @desc Updates an existing floodlight configuration. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.floodlightConfigurations.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.floodlightConfigurations.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightConfiguration} params.resource Request body data - * @param {object} [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$Floodlightconfigurations$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Floodlightconfigurations$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Floodlightconfigurations$Update, - callback: BodyResponseCallback - ): void; - update( - callback: BodyResponseCallback - ): void; - update( - paramsOrCallback?: - | Params$Resource$Floodlightconfigurations$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightconfigurations$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/floodlightConfigurations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightconfigurations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight configuration ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightconfigurations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. - */ - ids?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightconfigurations$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight configuration ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightConfiguration; - } - export interface Params$Resource$Floodlightconfigurations$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightConfiguration; - } - - export class Resource$Inventoryitems { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.inventoryItems.get - * @desc Gets one inventory item by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for order documents. - * projectId: '0', // TODO: Update placeholder value. - * - * // Inventory item ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.inventoryItems.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.inventoryItems.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Inventory item ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {object} [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$Inventoryitems$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Inventoryitems$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Inventoryitems$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Inventoryitems$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Inventoryitems$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Inventoryitems$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.inventoryItems.list - * @desc Retrieves a list of inventory items, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for order documents. - * projectId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var inventoryItemsPage = response['inventoryItems']; - * if (!inventoryItemsPage) { - * return; - * } - * for (var i = 0; i < inventoryItemsPage.length; i++) { - * // TODO: Change code below to process each resource in `inventoryItemsPage`: - * console.log(JSON.stringify(inventoryItemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.inventoryItems.list(request, handlePage); - * } - * }; - * - * dfareporting.inventoryItems.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.inventoryItems.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only inventory items with these IDs. - * @param {boolean=} params.inPlan Select only inventory items that are in plan. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.orderId Select only inventory items that belong to specified orders. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {string=} params.siteId Select only inventory items that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.type Select only inventory items with this 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 - */ - list( - params?: Params$Resource$Inventoryitems$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Inventoryitems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Inventoryitems$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Inventoryitems$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Inventoryitems$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Inventoryitems$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/projects/{projectId}/inventoryItems' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Inventoryitems$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Inventory item ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - } - export interface Params$Resource$Inventoryitems$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only inventory items with these IDs. - */ - ids?: string[]; - /** - * Select only inventory items that are in plan. - */ - inPlan?: boolean; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only inventory items that belong to specified orders. - */ - orderId?: string[]; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - /** - * Select only inventory items that are associated with these sites. - */ - siteId?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only inventory items with this type. - */ - type?: string; - } - - export class Resource$Languages { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.languages.list - * @desc Retrieves a list of languages. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.languages.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.languages.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Languages$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Languages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Languages$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Languages$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Languages$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Languages$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/languages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Languages$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Metros { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.metros.list - * @desc Retrieves a list of metros. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.metros.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.metros.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Metros$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Metros$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Metros$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Metros$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Metros$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Metros$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/metros' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Metros$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Mobileapps { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.mobileApps.get - * @desc Gets one mobile app by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Mobile app ID. - * id: 'my-id', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.mobileApps.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.mobileApps.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Mobile app ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Mobileapps$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Mobileapps$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Mobileapps$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Mobileapps$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobileapps$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/mobileApps/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.mobileApps.list - * @desc Retrieves list of available mobile apps. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var mobileAppsPage = response['mobileApps']; - * if (!mobileAppsPage) { - * return; - * } - * for (var i = 0; i < mobileAppsPage.length; i++) { - * // TODO: Change code below to process each resource in `mobileAppsPage`: - * console.log(JSON.stringify(mobileAppsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.mobileApps.list(request, handlePage); - * } - * }; - * - * dfareporting.mobileApps.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.mobileApps.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.directories Select only apps from these directories. - * @param {string=} params.ids Select only apps with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". - * @param {object} [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$Mobileapps$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Mobileapps$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Mobileapps$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Mobileapps$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobileapps$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/mobileApps' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Mobileapps$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Mobile app ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Mobileapps$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only apps from these directories. - */ - directories?: string[]; - /** - * Select only apps with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". - */ - searchString?: string; - } - - export class Resource$Mobilecarriers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.mobileCarriers.get - * @desc Gets one mobile carrier by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Mobile carrier ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.mobileCarriers.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.mobileCarriers.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Mobile carrier ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Mobilecarriers$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Mobilecarriers$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Mobilecarriers$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Mobilecarriers$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Mobilecarriers$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobilecarriers$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/mobileCarriers/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.mobileCarriers.list - * @desc Retrieves a list of mobile carriers. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.mobileCarriers.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.mobileCarriers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Mobilecarriers$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Mobilecarriers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Mobilecarriers$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Mobilecarriers$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Mobilecarriers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobilecarriers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/mobileCarriers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Mobilecarriers$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Mobile carrier ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Mobilecarriers$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Operatingsystems { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.operatingSystems.get - * @desc Gets one operating system by DART ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Operating system DART ID. - * dartId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.operatingSystems.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.operatingSystems.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dartId Operating system DART ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Operatingsystems$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Operatingsystems$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Operatingsystems$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Operatingsystems$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Operatingsystems$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystems$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/operatingSystems/{dartId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'dartId'], - pathParams: ['dartId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.operatingSystems.list - * @desc Retrieves a list of operating systems. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.operatingSystems.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.operatingSystems.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Operatingsystems$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Operatingsystems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Operatingsystems$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Operatingsystems$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Operatingsystems$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystems$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/operatingSystems' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Operatingsystems$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Operating system DART ID. - */ - dartId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Operatingsystems$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Operatingsystemversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.operatingSystemVersions.get - * @desc Gets one operating system version by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Operating system version ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.operatingSystemVersions.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.operatingSystemVersions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Operating system version ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Operatingsystemversions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Operatingsystemversions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Operatingsystemversions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Operatingsystemversions$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Operatingsystemversions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystemversions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/operatingSystemVersions/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.operatingSystemVersions.list - * @desc Retrieves a list of operating system versions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.operatingSystemVersions.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.operatingSystemVersions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Operatingsystemversions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Operatingsystemversions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Operatingsystemversions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Operatingsystemversions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OperatingSystemVersionsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Operatingsystemversions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystemversions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/operatingSystemVersions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Operatingsystemversions$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Operating system version ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Operatingsystemversions$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Orderdocuments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.orderDocuments.get - * @desc Gets one order document by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for order documents. - * projectId: '0', // TODO: Update placeholder value. - * - * // Order document ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.orderDocuments.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.orderDocuments.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Order document ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {object} [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$Orderdocuments$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Orderdocuments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Orderdocuments$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Orderdocuments$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Orderdocuments$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderdocuments$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.orderDocuments.list - * @desc Retrieves a list of order documents, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for order documents. - * projectId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var orderDocumentsPage = response['orderDocuments']; - * if (!orderDocumentsPage) { - * return; - * } - * for (var i = 0; i < orderDocumentsPage.length; i++) { - * // TODO: Change code below to process each resource in `orderDocumentsPage`: - * console.log(JSON.stringify(orderDocumentsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.orderDocuments.list(request, handlePage); - * } - * }; - * - * dfareporting.orderDocuments.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.orderDocuments.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.approved Select only order documents that have been approved by at least one user. - * @param {string=} params.ids Select only order documents with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.orderId Select only order documents for specified orders. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {string=} params.searchString Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". - * @param {string=} params.siteId Select only order documents that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Orderdocuments$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Orderdocuments$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Orderdocuments$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Orderdocuments$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Orderdocuments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderdocuments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/projects/{projectId}/orderDocuments' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Orderdocuments$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Order document ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - } - export interface Params$Resource$Orderdocuments$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only order documents that have been approved by at least one user. - */ - approved?: boolean; - /** - * Select only order documents with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only order documents for specified orders. - */ - orderId?: string[]; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - /** - * Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". - */ - searchString?: string; - /** - * Select only order documents that are associated with these sites. - */ - siteId?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Orders { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.orders.get - * @desc Gets one order by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for orders. - * projectId: '0', // TODO: Update placeholder value. - * - * // Order ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.orders.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.orders.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Order ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for orders. - * @param {object} [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$Orders$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Orders$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Orders$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Orders$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/projects/{projectId}/orders/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.orders.list - * @desc Retrieves a list of orders, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID for orders. - * projectId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var ordersPage = response['orders']; - * if (!ordersPage) { - * return; - * } - * for (var i = 0; i < ordersPage.length; i++) { - * // TODO: Change code below to process each resource in `ordersPage`: - * console.log(JSON.stringify(ordersPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.orders.list(request, handlePage); - * } - * }; - * - * dfareporting.orders.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.orders.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only orders with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for orders. - * @param {string=} params.searchString Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". - * @param {string=} params.siteId Select only orders that are associated with these site IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Orders$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Orders$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Orders$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Orders$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/projects/{projectId}/orders' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Orders$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Order ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for orders. - */ - projectId?: string; - } - export interface Params$Resource$Orders$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only orders with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for orders. - */ - projectId?: string; - /** - * Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". - */ - searchString?: string; - /** - * Select only orders that are associated with these site IDs. - */ - siteId?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Placementgroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.placementGroups.get - * @desc Gets one placement group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placementGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Placementgroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Placementgroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Placementgroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Placementgroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementGroups.insert - * @desc Inserts a new placement group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementGroups.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} params.resource Request body data - * @param {object} [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$Placementgroups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Placementgroups$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Placementgroups$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Placementgroups$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementGroups.list - * @desc Retrieves a list of placement groups, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var placementGroupsPage = response['placementGroups']; - * if (!placementGroupsPage) { - * return; - * } - * for (var i = 0; i < placementGroupsPage.length; i++) { - * // TODO: Change code below to process each resource in `placementGroupsPage`: - * console.log(JSON.stringify(placementGroupsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.placementGroups.list(request, handlePage); - * } - * }; - * - * dfareporting.placementGroups.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only placement groups that belong to these advertisers. - * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. - * @param {string=} params.campaignIds Select only placement groups that belong to these campaigns. - * @param {string=} params.contentCategoryIds Select only placement groups that are associated with these content categories. - * @param {string=} params.directorySiteIds Select only placement groups that are associated with these directory sites. - * @param {string=} params.ids Select only placement groups with these IDs. - * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. - * @param {string=} params.placementStrategyIds Select only placement groups that are associated with these placement strategies. - * @param {string=} params.pricingTypes Select only placement groups with these pricing types. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". - * @param {string=} params.siteIds Select only placement groups that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Placementgroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Placementgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Placementgroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Placementgroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementGroups.patch - * @desc Updates an existing placement group. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement group ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementGroups.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} params.resource Request body data - * @param {object} [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$Placementgroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Placementgroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Placementgroups$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Placementgroups$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementGroups.update - * @desc Updates an existing placement group. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementGroups.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} params.resource Request body data - * @param {object} [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$Placementgroups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Placementgroups$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Placementgroups$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Placementgroups$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placementgroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementgroups$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - export interface Params$Resource$Placementgroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only placement groups that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only archived placements. Don't set this field to select both archived and non-archived placements. - */ - archived?: boolean; - /** - * Select only placement groups that belong to these campaigns. - */ - campaignIds?: string[]; - /** - * Select only placement groups that are associated with these content categories. - */ - contentCategoryIds?: string[]; - /** - * Select only placement groups that are associated with these directory sites. - */ - directorySiteIds?: string[]; - /** - * Select only placement groups with these IDs. - */ - ids?: string[]; - /** - * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - */ - maxEndDate?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - */ - maxStartDate?: string; - /** - * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - */ - minEndDate?: string; - /** - * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - */ - minStartDate?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. - */ - placementGroupType?: string; - /** - * Select only placement groups that are associated with these placement strategies. - */ - placementStrategyIds?: string[]; - /** - * Select only placement groups with these pricing types. - */ - pricingTypes?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". - */ - searchString?: string; - /** - * Select only placement groups that are associated with these sites. - */ - siteIds?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placementgroups$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - export interface Params$Resource$Placementgroups$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - - export class Resource$Placements { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.placements.generatetags - * @desc Generates tags for a placement. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placements.generatetags(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.generatetags - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.campaignId Generate placements belonging to this campaign. This is a required field. - * @param {string=} params.placementIds Generate tags for these placements. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.tagFormats Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - generatetags( - params?: Params$Resource$Placements$Generatetags, - options?: MethodOptions - ): GaxiosPromise; - generatetags( - params: Params$Resource$Placements$Generatetags, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generatetags( - params: Params$Resource$Placements$Generatetags, - callback: BodyResponseCallback - ): void; - generatetags( - callback: BodyResponseCallback - ): void; - generatetags( - paramsOrCallback?: - | Params$Resource$Placements$Generatetags - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placements$Generatetags; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Generatetags; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placements/generatetags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.placements.get - * @desc Gets one placement by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placements.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Placements$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Placements$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Placements$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Placements$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placements/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placements.insert - * @desc Inserts a new placement. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placements.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} params.resource Request body data - * @param {object} [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$Placements$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Placements$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Placements$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Placements$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placements$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/placements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placements.list - * @desc Retrieves a list of placements, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var placementsPage = response['placements']; - * if (!placementsPage) { - * return; - * } - * for (var i = 0; i < placementsPage.length; i++) { - * // TODO: Change code below to process each resource in `placementsPage`: - * console.log(JSON.stringify(placementsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.placements.list(request, handlePage); - * } - * }; - * - * dfareporting.placements.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only placements that belong to these advertisers. - * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. - * @param {string=} params.campaignIds Select only placements that belong to these campaigns. - * @param {string=} params.compatibilities Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. - * @param {string=} params.contentCategoryIds Select only placements that are associated with these content categories. - * @param {string=} params.directorySiteIds Select only placements that are associated with these directory sites. - * @param {string=} params.groupIds Select only placements that belong to these placement groups. - * @param {string=} params.ids Select only placements with these IDs. - * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.paymentSource Select only placements with this payment source. - * @param {string=} params.placementStrategyIds Select only placements that are associated with these placement strategies. - * @param {string=} params.pricingTypes Select only placements with these pricing types. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". - * @param {string=} params.siteIds Select only placements that are associated with these sites. - * @param {string=} params.sizeIds Select only placements that are associated with these sizes. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Placements$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Placements$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Placements$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Placements$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/placements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placements.patch - * @desc Updates an existing placement. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placements.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} params.resource Request body data - * @param {object} [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$Placements$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Placements$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Placements$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Placements$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/placements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placements.update - * @desc Updates an existing placement. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placements.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placements.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} params.resource Request body data - * @param {object} [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$Placements$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Placements$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Placements$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Placements$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placements$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/placements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placements$Generatetags - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Generate placements belonging to this campaign. This is a required field. - */ - campaignId?: string; - /** - * Generate tags for these placements. - */ - placementIds?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. - */ - tagFormats?: string[]; - } - export interface Params$Resource$Placements$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placements$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - export interface Params$Resource$Placements$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only placements that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only archived placements. Don't set this field to select both archived and non-archived placements. - */ - archived?: boolean; - /** - * Select only placements that belong to these campaigns. - */ - campaignIds?: string[]; - /** - * Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. - */ - compatibilities?: string[]; - /** - * Select only placements that are associated with these content categories. - */ - contentCategoryIds?: string[]; - /** - * Select only placements that are associated with these directory sites. - */ - directorySiteIds?: string[]; - /** - * Select only placements that belong to these placement groups. - */ - groupIds?: string[]; - /** - * Select only placements with these IDs. - */ - ids?: string[]; - /** - * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - */ - maxEndDate?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - */ - maxStartDate?: string; - /** - * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - */ - minEndDate?: string; - /** - * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - */ - minStartDate?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only placements with this payment source. - */ - paymentSource?: string; - /** - * Select only placements that are associated with these placement strategies. - */ - placementStrategyIds?: string[]; - /** - * Select only placements with these pricing types. - */ - pricingTypes?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". - */ - searchString?: string; - /** - * Select only placements that are associated with these sites. - */ - siteIds?: string[]; - /** - * Select only placements that are associated with these sizes. - */ - sizeIds?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placements$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - export interface Params$Resource$Placements$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - - export class Resource$Placementstrategies { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.placementStrategies.delete - * @desc Deletes an existing placement strategy. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement strategy ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Placementstrategies$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Placementstrategies$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Placementstrategies$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementStrategies/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementStrategies.get - * @desc Gets one placement strategy by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement strategy ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Placementstrategies$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Placementstrategies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Placementstrategies$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementStrategies/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementStrategies.insert - * @desc Inserts a new placement strategy. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} params.resource Request body data - * @param {object} [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$Placementstrategies$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Placementstrategies$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Placementstrategies$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementStrategies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementStrategies.list - * @desc Retrieves a list of placement strategies, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var placementStrategiesPage = response['placementStrategies']; - * if (!placementStrategiesPage) { - * return; - * } - * for (var i = 0; i < placementStrategiesPage.length; i++) { - * // TODO: Change code below to process each resource in `placementStrategiesPage`: - * console.log(JSON.stringify(placementStrategiesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.placementStrategies.list(request, handlePage); - * } - * }; - * - * dfareporting.placementStrategies.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only placement strategies with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Placementstrategies$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Placementstrategies$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Placementstrategies$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Placementstrategies$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementStrategies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.placementStrategies.patch - * @desc Updates an existing placement strategy. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Placement strategy ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} params.resource Request body data - * @param {object} [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$Placementstrategies$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Placementstrategies$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Placementstrategies$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementStrategies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementStrategies.update - * @desc Updates an existing placement strategy. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.placementStrategies.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.placementStrategies.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} params.resource Request body data - * @param {object} [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$Placementstrategies$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Placementstrategies$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Placementstrategies$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/placementStrategies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placementstrategies$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementstrategies$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementstrategies$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - export interface Params$Resource$Placementstrategies$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only placement strategies with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placementstrategies$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - export interface Params$Resource$Placementstrategies$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - - export class Resource$Platformtypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.platformTypes.get - * @desc Gets one platform type by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Platform type ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.platformTypes.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.platformTypes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Platform type ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Platformtypes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Platformtypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Platformtypes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Platformtypes$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Platformtypes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Platformtypes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/platformTypes/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.platformTypes.list - * @desc Retrieves a list of platform types. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.platformTypes.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.platformTypes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Platformtypes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Platformtypes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Platformtypes$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Platformtypes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Platformtypes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Platformtypes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/platformTypes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Platformtypes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Platform type ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Platformtypes$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Postalcodes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.postalCodes.get - * @desc Gets one postal code by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Postal code ID. - * code: 'my-code', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.postalCodes.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.postalCodes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.code Postal code ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Postalcodes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Postalcodes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Postalcodes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Postalcodes$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Postalcodes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/postalCodes/{code}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'code'], - pathParams: ['code', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.postalCodes.list - * @desc Retrieves a list of postal codes. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.postalCodes.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.postalCodes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Postalcodes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Postalcodes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Postalcodes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Postalcodes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Postalcodes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/postalCodes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Postalcodes$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Postal code ID. - */ - code?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Postalcodes$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Projects { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.projects.get - * @desc Gets one project by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Project ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.projects.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.projects.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Project ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/projects/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.projects.list - * @desc Retrieves a list of projects, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var projectsPage = response['projects']; - * if (!projectsPage) { - * return; - * } - * for (var i = 0; i < projectsPage.length; i++) { - * // TODO: Change code below to process each resource in `projectsPage`: - * console.log(JSON.stringify(projectsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.projects.list(request, handlePage); - * } - * }; - * - * dfareporting.projects.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.projects.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only projects with these advertiser IDs. - * @param {string=} params.ids Select only projects with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/projects' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Project ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Projects$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only projects with these advertiser IDs. - */ - advertiserIds?: string[]; - /** - * Select only projects with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Regions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.regions.list - * @desc Retrieves a list of regions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.regions.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.regions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Regions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regions$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regions$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Regions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/regions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Regions$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Remarketinglists { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.remarketingLists.get - * @desc Gets one remarketing list by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.remarketingLists.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Remarketinglists$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Remarketinglists$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Remarketinglists$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Remarketinglists$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/remarketingLists/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingLists.insert - * @desc Inserts a new remarketing list. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingLists.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} params.resource Request body data - * @param {object} [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$Remarketinglists$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Remarketinglists$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Remarketinglists$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Remarketinglists$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/remarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingLists.list - * @desc Retrieves a list of remarketing lists, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Select only remarketing lists owned by this advertiser. - * advertiserId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var remarketingListsPage = response['remarketingLists']; - * if (!remarketingListsPage) { - * return; - * } - * for (var i = 0; i < remarketingListsPage.length; i++) { - * // TODO: Change code below to process each resource in `remarketingListsPage`: - * console.log(JSON.stringify(remarketingListsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.remarketingLists.list(request, handlePage); - * } - * }; - * - * dfareporting.remarketingLists.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active or only inactive remarketing lists. - * @param {string} params.advertiserId Select only remarketing lists owned by this advertiser. - * @param {string=} params.floodlightActivityId Select only remarketing lists that have this floodlight activity ID. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Remarketinglists$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Remarketinglists$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Remarketinglists$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Remarketinglists$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/remarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.remarketingLists.patch - * @desc Updates an existing remarketing list. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingLists.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} params.resource Request body data - * @param {object} [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$Remarketinglists$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Remarketinglists$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Remarketinglists$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Remarketinglists$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/remarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingLists.update - * @desc Updates an existing remarketing list. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingLists.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingLists.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} params.resource Request body data - * @param {object} [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$Remarketinglists$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Remarketinglists$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Remarketinglists$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Remarketinglists$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/remarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Remarketinglists$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Remarketinglists$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - export interface Params$Resource$Remarketinglists$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active or only inactive remarketing lists. - */ - active?: boolean; - /** - * Select only remarketing lists owned by this advertiser. - */ - advertiserId?: string; - /** - * Select only remarketing lists that have this floodlight activity ID. - */ - floodlightActivityId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - */ - name?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Remarketinglists$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - export interface Params$Resource$Remarketinglists$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - - export class Resource$Remarketinglistshares { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.remarketingListShares.get - * @desc Gets one remarketing list share by remarketing list ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * remarketingListId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.remarketingListShares.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingListShares.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.remarketingListId Remarketing list 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$Remarketinglistshares$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Remarketinglistshares$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Remarketinglistshares$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Remarketinglistshares$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglistshares$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/remarketingListShares/{remarketingListId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'remarketingListId'], - pathParams: ['profileId', 'remarketingListId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingListShares.patch - * @desc Updates an existing remarketing list share. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * remarketingListId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingListShares.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingListShares.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.remarketingListId Remarketing list ID. - * @param {().RemarketingListShare} params.resource Request body data - * @param {object} [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$Remarketinglistshares$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Remarketinglistshares$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Remarketinglistshares$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Remarketinglistshares$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglistshares$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/remarketingListShares' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'remarketingListId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingListShares.update - * @desc Updates an existing remarketing list share. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.remarketingListShares.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.remarketingListShares.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingListShare} params.resource Request body data - * @param {object} [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$Remarketinglistshares$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Remarketinglistshares$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Remarketinglistshares$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Remarketinglistshares$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglistshares$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/remarketingListShares' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Remarketinglistshares$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Remarketing list ID. - */ - remarketingListId?: string; - } - export interface Params$Resource$Remarketinglistshares$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Remarketing list ID. - */ - remarketingListId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingListShare; - } - export interface Params$Resource$Remarketinglistshares$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingListShare; - } - - export class Resource$Reports { - context: APIRequestContext; - compatibleFields: Resource$Reports$Compatiblefields; - files: Resource$Reports$Files; - constructor(context: APIRequestContext) { - this.context = context; - this.compatibleFields = new Resource$Reports$Compatiblefields( - this.context - ); - this.files = new Resource$Reports$Files(this.context); - } - - /** - * dfareporting.reports.delete - * @desc Deletes a report by its ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.reports.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {object} [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$Reports$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Reports$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Reports$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Reports$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/reports/{reportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.get - * @desc Retrieves a report by its ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.reports.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {object} [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$Reports$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Reports$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reports$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Reports$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/reports/{reportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.insert - * @desc Creates a report. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.reports.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {().Report} params.resource Request body data - * @param {object} [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$Reports$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Reports$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Reports$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Reports$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/reports' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.list - * @desc Retrieves list of reports. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.reports.list(request, handlePage); - * } - * }; - * - * dfareporting.reports.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA user profile ID. - * @param {string=} params.scope The scope that defines which results are returned. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Reports$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Reports$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reports$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Reports$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/reports' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.patch - * @desc Updates a report. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.reports.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {().Report} params.resource Request body data - * @param {object} [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$Reports$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Reports$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Reports$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Reports$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/reports/{reportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.run - * @desc Runs a report. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.reports.run(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.run - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the report. - * @param {boolean=} params.synchronous If set and true, tries to run the report synchronously. - * @param {object} [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$Reports$Run, - options?: MethodOptions - ): GaxiosPromise; - run( - params: Params$Resource$Reports$Run, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - run( - params: Params$Resource$Reports$Run, - callback: BodyResponseCallback - ): void; - run(callback: BodyResponseCallback): void; - run( - paramsOrCallback?: - | Params$Resource$Reports$Run - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Run; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Run; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/reports/{reportId}/run' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.update - * @desc Updates a report. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.reports.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {().Report} params.resource Request body data - * @param {object} [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$Reports$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Reports$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Reports$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Reports$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/reports/{reportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - export interface Params$Resource$Reports$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The scope that defines which results are returned. - */ - scope?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Reports$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - export interface Params$Resource$Reports$Run extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - /** - * If set and true, tries to run the report synchronously. - */ - synchronous?: boolean; - } - export interface Params$Resource$Reports$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - - export class Resource$Reports$Compatiblefields { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.reports.compatibleFields.query - * @desc Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.reports.compatibleFields.query(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.compatibleFields.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {().Report} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - query( - params?: Params$Resource$Reports$Compatiblefields$Query, - options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Reports$Compatiblefields$Query, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Reports$Compatiblefields$Query, - callback: BodyResponseCallback - ): void; - query(callback: BodyResponseCallback): void; - query( - paramsOrCallback?: - | Params$Resource$Reports$Compatiblefields$Query - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Reports$Compatiblefields$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Compatiblefields$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/reports/compatiblefields/query' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Compatiblefields$Query - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - - export class Resource$Reports$Files { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.reports.files.get - * @desc Retrieves a report file. This method supports media download. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the report. - * reportId: '0', // TODO: Update placeholder value. - * - * // The ID of the report file. - * fileId: '0', // TODO: Update placeholder value. - * - * // TODO: To download media content, use: - * // - * // alt: 'media', - * - * auth: authClient, - * }; - * - * dfareporting.reports.files.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.files.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the report file. - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the report. - * @param {object} [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$Reports$Files$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Reports$Files$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reports$Files$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Reports$Files$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Reports$Files$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Files$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/reports/{reportId}/files/{fileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId', 'fileId'], - pathParams: ['fileId', 'profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.files.list - * @desc Lists files for a report. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The DFA profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * // The ID of the parent report. - * reportId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var itemsPage = response['items']; - * if (!itemsPage) { - * return; - * } - * for (var i = 0; i < itemsPage.length; i++) { - * // TODO: Change code below to process each resource in `itemsPage`: - * console.log(JSON.stringify(itemsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.reports.files.list(request, handlePage); - * } - * }; - * - * dfareporting.reports.files.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfareporting' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.reports.files.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the parent report. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Reports$Files$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Reports$Files$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reports$Files$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Reports$Files$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Reports$Files$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Files$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/reports/{reportId}/files' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Files$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the report file. - */ - fileId?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Files$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the parent report. - */ - reportId?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Sites { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.sites.get - * @desc Gets one site by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Site ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.sites.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Site ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Sites$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Sites$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Sites$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Sites$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/sites/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sites.insert - * @desc Inserts a new site. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.sites.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} params.resource Request body data - * @param {object} [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$Sites$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Sites$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Sites$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Sites$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sites.list - * @desc Retrieves a list of sites, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var sitesPage = response['sites']; - * if (!sitesPage) { - * return; - * } - * for (var i = 0; i < sitesPage.length; i++) { - * // TODO: Change code below to process each resource in `sitesPage`: - * console.log(JSON.stringify(sitesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.sites.list(request, handlePage); - * } - * }; - * - * dfareporting.sites.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements. - * @param {boolean=} params.adWordsSite Select only AdWords sites. - * @param {boolean=} params.approved Select only approved sites. - * @param {string=} params.campaignIds Select only sites with these campaign IDs. - * @param {string=} params.directorySiteIds Select only sites with these directory site IDs. - * @param {string=} params.ids Select only sites with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only sites with this subaccount ID. - * @param {boolean=} params.unmappedSite Select only sites that have not been mapped to a directory site. - * @param {object} [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$Sites$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Sites$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Sites$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Sites$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sites.patch - * @desc Updates an existing site. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Site ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.sites.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Site ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} params.resource Request body data - * @param {object} [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$Sites$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Sites$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Sites$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Sites$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sites.update - * @desc Updates an existing site. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.sites.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sites.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} params.resource Request body data - * @param {object} [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$Sites$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Sites$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Sites$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Sites$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Sites$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Sites$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - export interface Params$Resource$Sites$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * This search filter is no longer supported and will have no effect on the results returned. - */ - acceptsInStreamVideoPlacements?: boolean; - /** - * This search filter is no longer supported and will have no effect on the results returned. - */ - acceptsInterstitialPlacements?: boolean; - /** - * Select only sites that accept publisher paid placements. - */ - acceptsPublisherPaidPlacements?: boolean; - /** - * Select only AdWords sites. - */ - adWordsSite?: boolean; - /** - * Select only approved sites. - */ - approved?: boolean; - /** - * Select only sites with these campaign IDs. - */ - campaignIds?: string[]; - /** - * Select only sites with these directory site IDs. - */ - directorySiteIds?: string[]; - /** - * Select only sites with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only sites with this subaccount ID. - */ - subaccountId?: string; - /** - * Select only sites that have not been mapped to a directory site. - */ - unmappedSite?: boolean; - } - export interface Params$Resource$Sites$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - export interface Params$Resource$Sites$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - - export class Resource$Sizes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.sizes.get - * @desc Gets one size by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Size ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.sizes.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sizes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Size ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Sizes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Sizes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Sizes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Sizes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/sizes/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sizes.insert - * @desc Inserts a new size. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.sizes.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sizes.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Size} params.resource Request body data - * @param {object} [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$Sizes$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Sizes$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Sizes$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Sizes$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/sizes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sizes.list - * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.sizes.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.sizes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.height Select only sizes with this height. - * @param {boolean=} params.iabStandard Select only IAB standard sizes. - * @param {string=} params.ids Select only sizes with these IDs. - * @param {string} params.profileId User profile ID associated with this request. - * @param {integer=} params.width Select only sizes with this width. - * @param {object} [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$Sizes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Sizes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Sizes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Sizes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/sizes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Sizes$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Size ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Sizes$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Size; - } - export interface Params$Resource$Sizes$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only sizes with this height. - */ - height?: number; - /** - * Select only IAB standard sizes. - */ - iabStandard?: boolean; - /** - * Select only sizes with these IDs. - */ - ids?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only sizes with this width. - */ - width?: number; - } - - export class Resource$Subaccounts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.subaccounts.get - * @desc Gets one subaccount by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Subaccount ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.subaccounts.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Subaccount ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Subaccounts$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Subaccounts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Subaccounts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Subaccounts$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/subaccounts/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.subaccounts.insert - * @desc Inserts a new subaccount. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.subaccounts.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} params.resource Request body data - * @param {object} [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$Subaccounts$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Subaccounts$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Subaccounts$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Subaccounts$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Subaccounts$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/subaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.subaccounts.list - * @desc Gets a list of subaccounts, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var subaccountsPage = response['subaccounts']; - * if (!subaccountsPage) { - * return; - * } - * for (var i = 0; i < subaccountsPage.length; i++) { - * // TODO: Change code below to process each resource in `subaccountsPage`: - * console.log(JSON.stringify(subaccountsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.subaccounts.list(request, handlePage); - * } - * }; - * - * dfareporting.subaccounts.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only subaccounts with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Subaccounts$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Subaccounts$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Subaccounts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Subaccounts$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/subaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.subaccounts.patch - * @desc Updates an existing subaccount. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Subaccount ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.subaccounts.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Subaccount ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} params.resource Request body data - * @param {object} [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$Subaccounts$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Subaccounts$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Subaccounts$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Subaccounts$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Subaccounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/subaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.subaccounts.update - * @desc Updates an existing subaccount. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.subaccounts.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.subaccounts.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} params.resource Request body data - * @param {object} [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$Subaccounts$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Subaccounts$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Subaccounts$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Subaccounts$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Subaccounts$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/subaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Subaccounts$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Subaccount ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Subaccounts$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - export interface Params$Resource$Subaccounts$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only subaccounts with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Subaccounts$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Subaccount ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - export interface Params$Resource$Subaccounts$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - - export class Resource$Targetableremarketinglists { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.targetableRemarketingLists.get - * @desc Gets one remarketing list by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Remarketing list ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.targetableRemarketingLists.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetableRemarketingLists.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Targetableremarketinglists$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Targetableremarketinglists$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Targetableremarketinglists$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Targetableremarketinglists$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetableremarketinglists$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetableremarketinglists$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/targetableRemarketingLists/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.targetableRemarketingLists.list - * @desc Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Select only targetable remarketing lists targetable by these advertisers. - * advertiserId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var targetableRemarketingListsPage = response['targetableRemarketingLists']; - * if (!targetableRemarketingListsPage) { - * return; - * } - * for (var i = 0; i < targetableRemarketingListsPage.length; i++) { - * // TODO: Change code below to process each resource in `targetableRemarketingListsPage`: - * console.log(JSON.stringify(targetableRemarketingListsPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.targetableRemarketingLists.list(request, handlePage); - * } - * }; - * - * dfareporting.targetableRemarketingLists.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetableRemarketingLists.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active or only inactive targetable remarketing lists. - * @param {string} params.advertiserId Select only targetable remarketing lists targetable by these advertisers. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Targetableremarketinglists$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Targetableremarketinglists$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse - > - ): void; - list( - params: Params$Resource$Targetableremarketinglists$List, - callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Targetableremarketinglists$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetableremarketinglists$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetableremarketinglists$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/targetableRemarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Targetableremarketinglists$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Targetableremarketinglists$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active or only inactive targetable remarketing lists. - */ - active?: boolean; - /** - * Select only targetable remarketing lists targetable by these advertisers. - */ - advertiserId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - */ - name?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Targetingtemplates { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.targetingTemplates.get - * @desc Gets one targeting template by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Targeting template ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.targetingTemplates.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Targeting template ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Targetingtemplates$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Targetingtemplates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Targetingtemplates$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/targetingTemplates/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.targetingTemplates.insert - * @desc Inserts a new targeting template. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.targetingTemplates.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} params.resource Request body data - * @param {object} [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$Targetingtemplates$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Targetingtemplates$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Targetingtemplates$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/targetingTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.targetingTemplates.list - * @desc Retrieves a list of targeting templates, optionally filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var targetingTemplatesPage = response['targetingTemplates']; - * if (!targetingTemplatesPage) { - * return; - * } - * for (var i = 0; i < targetingTemplatesPage.length; i++) { - * // TODO: Change code below to process each resource in `targetingTemplatesPage`: - * console.log(JSON.stringify(targetingTemplatesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.targetingTemplates.list(request, handlePage); - * } - * }; - * - * dfareporting.targetingTemplates.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only targeting templates with this advertiser ID. - * @param {string=} params.ids Select only targeting templates with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Targetingtemplates$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Targetingtemplates$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Targetingtemplates$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/targetingTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.targetingTemplates.patch - * @desc Updates an existing targeting template. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Targeting template ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.targetingTemplates.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Targeting template ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} params.resource Request body data - * @param {object} [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$Targetingtemplates$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Targetingtemplates$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Targetingtemplates$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/targetingTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.targetingTemplates.update - * @desc Updates an existing targeting template. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.targetingTemplates.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.targetingTemplates.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} params.resource Request body data - * @param {object} [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$Targetingtemplates$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Targetingtemplates$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Targetingtemplates$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/targetingTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Targetingtemplates$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Targeting template ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Targetingtemplates$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - export interface Params$Resource$Targetingtemplates$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only targeting templates with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only targeting templates with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Targetingtemplates$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Targeting template ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - export interface Params$Resource$Targetingtemplates$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - - export class Resource$Userprofiles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.userProfiles.get - * @desc Gets one user profile by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // The user profile ID. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userProfiles.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using one of the following scopes: - * // 'https://www.googleapis.com/auth/dfareporting' - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userProfiles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The user profile 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$Userprofiles$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Userprofiles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Userprofiles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Userprofiles$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userprofiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userprofiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userProfiles.list - * @desc Retrieves list of user profiles for a user. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * auth: authClient, - * }; - * - * dfareporting.userProfiles.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using one of the following scopes: - * // 'https://www.googleapis.com/auth/dfareporting' - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userProfiles.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Userprofiles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Userprofiles$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Userprofiles$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Userprofiles$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userprofiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userprofiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/dfareporting/v3.1/userprofiles').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$Userprofiles$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The user profile ID. - */ - profileId?: string; - } - export interface Params$Resource$Userprofiles$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - } - - export class Resource$Userrolepermissiongroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.userRolePermissionGroups.get - * @desc Gets one user role permission group by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role permission group ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRolePermissionGroups.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRolePermissionGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role permission group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Userrolepermissiongroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Userrolepermissiongroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Userrolepermissiongroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Userrolepermissiongroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userrolepermissiongroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissiongroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/userRolePermissionGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRolePermissionGroups.list - * @desc Gets a list of all supported user role permission groups. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRolePermissionGroups.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRolePermissionGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Userrolepermissiongroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Userrolepermissiongroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$UserRolePermissionGroupsListResponse - > - ): void; - list( - params: Params$Resource$Userrolepermissiongroups$List, - callback: BodyResponseCallback< - Schema$UserRolePermissionGroupsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$UserRolePermissionGroupsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Userrolepermissiongroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$UserRolePermissionGroupsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userrolepermissiongroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissiongroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/userRolePermissionGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Userrolepermissiongroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role permission group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userrolepermissiongroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Userrolepermissions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.userRolePermissions.get - * @desc Gets one user role permission by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role permission ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRolePermissions.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRolePermissions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role permission ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Userrolepermissions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Userrolepermissions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Userrolepermissions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Userrolepermissions$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userrolepermissions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/userRolePermissions/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRolePermissions.list - * @desc Gets a list of user role permissions, possibly filtered. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRolePermissions.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRolePermissions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only user role permissions with these IDs. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Userrolepermissions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Userrolepermissions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Userrolepermissions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Userrolepermissions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userrolepermissions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/userRolePermissions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Userrolepermissions$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role permission ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userrolepermissions$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only user role permissions with these IDs. - */ - ids?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Userroles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.userRoles.delete - * @desc Deletes an existing user role. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Userroles$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Userroles$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Userroles$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Userroles$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/userRoles/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.get - * @desc Gets one user role by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role ID. - * id: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Userroles$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Userroles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Userroles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Userroles$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/userRoles/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.insert - * @desc Inserts a new user role. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.insert(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} params.resource Request body data - * @param {object} [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$Userroles$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Userroles$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Userroles$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Userroles$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/userRoles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.list - * @desc Retrieves a list of user roles, possibly filtered. This method supports paging. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * var handlePage = function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * var userRolesPage = response['userRoles']; - * if (!userRolesPage) { - * return; - * } - * for (var i = 0; i < userRolesPage.length; i++) { - * // TODO: Change code below to process each resource in `userRolesPage`: - * console.log(JSON.stringify(userRolesPage[i], null, 2)); - * } - * - * if (response.nextPageToken) { - * request.pageToken = response.nextPageToken; - * dfareporting.userRoles.list(request, handlePage); - * } - * }; - * - * dfareporting.userRoles.list(request, handlePage); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.accountUserRoleOnly Select only account level user roles not associated with any specific subaccount. - * @param {string=} params.ids Select only user roles with the specified IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only user roles that belong to this subaccount. - * @param {object} [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$Userroles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Userroles$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Userroles$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Userroles$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/userRoles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.patch - * @desc Updates an existing user role. This method supports patch semantics. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // User role ID. - * id: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. Only these properties - * // will be changed. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.patch(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} params.resource Request body data - * @param {object} [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$Userroles$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Userroles$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Userroles$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Userroles$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/userRoles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.update - * @desc Updates an existing user role. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * resource: { - * // TODO: Add desired properties to the request body. All existing properties - * // will be replaced. - * }, - * - * auth: authClient, - * }; - * - * dfareporting.userRoles.update(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.userRoles.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} params.resource Request body data - * @param {object} [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$Userroles$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Userroles$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Userroles$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Userroles$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.1/userprofiles/{profileId}/userRoles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Userroles$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userroles$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userroles$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - export interface Params$Resource$Userroles$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only account level user roles not associated with any specific subaccount. - */ - accountUserRoleOnly?: boolean; - /** - * Select only user roles with the specified IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only user roles that belong to this subaccount. - */ - subaccountId?: string; - } - export interface Params$Resource$Userroles$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - export interface Params$Resource$Userroles$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - - export class Resource$Videoformats { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.videoFormats.get - * @desc Gets one video format by ID. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * // Video format ID. - * id: 0, // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.videoFormats.get(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.videoFormats.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.id Video format ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Videoformats$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Videoformats$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Videoformats$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Videoformats$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Videoformats$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Videoformats$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/videoFormats/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.videoFormats.list - * @desc Lists available video formats. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the DCM/DFA Reporting And Trafficking API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/dfareporting - * // 2. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var dfareporting = google.dfareporting('v3.1'); - * - * authorize(function(authClient) { - * var request = { - * // User profile ID associated with this request. - * profileId: '0', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * dfareporting.videoFormats.list(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * // TODO: Change placeholder below to generate authentication credentials. See - * // - * // - * // Authorize using the following scope: - * // 'https://www.googleapis.com/auth/dfatrafficking' - * var authClient = null; - * - * if (authClient == null) { - * console.log('authentication failed'); - * return; - * } - * callback(authClient); - * } - * @alias dfareporting.videoFormats.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Videoformats$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Videoformats$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Videoformats$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Videoformats$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Videoformats$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Videoformats$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.1/userprofiles/{profileId}/videoFormats' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Videoformats$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Video format ID. - */ - id?: number; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Videoformats$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } -} diff --git a/src/apis/dfareporting/v3.2.ts b/src/apis/dfareporting/v3.2.ts deleted file mode 100644 index f0d8e0c3a48..00000000000 --- a/src/apis/dfareporting/v3.2.ts +++ /dev/null @@ -1,27675 +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 dfareporting_v3_2 { - export interface Options extends GlobalOptions { - version: 'v3.2'; - } - - 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; - } - - /** - * DCM/DFA Reporting And Trafficking API - * - * Manages your DoubleClick Campaign Manager ad campaigns and reports. - * - * @example - * const {google} = require('googleapis'); - * const dfareporting = google.dfareporting('v3.2'); - * - * @namespace dfareporting - * @type {Function} - * @version v3.2 - * @variation v3.2 - * @param {object=} options Options for Dfareporting - */ - export class Dfareporting { - context: APIRequestContext; - accountActiveAdSummaries: Resource$Accountactiveadsummaries; - accountPermissionGroups: Resource$Accountpermissiongroups; - accountPermissions: Resource$Accountpermissions; - accounts: Resource$Accounts; - accountUserProfiles: Resource$Accountuserprofiles; - ads: Resource$Ads; - advertiserGroups: Resource$Advertisergroups; - advertiserLandingPages: Resource$Advertiserlandingpages; - advertisers: Resource$Advertisers; - browsers: Resource$Browsers; - campaignCreativeAssociations: Resource$Campaigncreativeassociations; - campaigns: Resource$Campaigns; - changeLogs: Resource$Changelogs; - cities: Resource$Cities; - connectionTypes: Resource$Connectiontypes; - contentCategories: Resource$Contentcategories; - conversions: Resource$Conversions; - countries: Resource$Countries; - creativeAssets: Resource$Creativeassets; - creativeFields: Resource$Creativefields; - creativeFieldValues: Resource$Creativefieldvalues; - creativeGroups: Resource$Creativegroups; - creatives: Resource$Creatives; - dimensionValues: Resource$Dimensionvalues; - directorySiteContacts: Resource$Directorysitecontacts; - directorySites: Resource$Directorysites; - dynamicTargetingKeys: Resource$Dynamictargetingkeys; - eventTags: Resource$Eventtags; - files: Resource$Files; - floodlightActivities: Resource$Floodlightactivities; - floodlightActivityGroups: Resource$Floodlightactivitygroups; - floodlightConfigurations: Resource$Floodlightconfigurations; - inventoryItems: Resource$Inventoryitems; - languages: Resource$Languages; - metros: Resource$Metros; - mobileApps: Resource$Mobileapps; - mobileCarriers: Resource$Mobilecarriers; - operatingSystems: Resource$Operatingsystems; - operatingSystemVersions: Resource$Operatingsystemversions; - orderDocuments: Resource$Orderdocuments; - orders: Resource$Orders; - placementGroups: Resource$Placementgroups; - placements: Resource$Placements; - placementStrategies: Resource$Placementstrategies; - platformTypes: Resource$Platformtypes; - postalCodes: Resource$Postalcodes; - projects: Resource$Projects; - regions: Resource$Regions; - remarketingLists: Resource$Remarketinglists; - remarketingListShares: Resource$Remarketinglistshares; - reports: Resource$Reports; - sites: Resource$Sites; - sizes: Resource$Sizes; - subaccounts: Resource$Subaccounts; - targetableRemarketingLists: Resource$Targetableremarketinglists; - targetingTemplates: Resource$Targetingtemplates; - userProfiles: Resource$Userprofiles; - userRolePermissionGroups: Resource$Userrolepermissiongroups; - userRolePermissions: Resource$Userrolepermissions; - userRoles: Resource$Userroles; - videoFormats: Resource$Videoformats; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.accountActiveAdSummaries = new Resource$Accountactiveadsummaries( - this.context - ); - this.accountPermissionGroups = new Resource$Accountpermissiongroups( - this.context - ); - this.accountPermissions = new Resource$Accountpermissions(this.context); - this.accounts = new Resource$Accounts(this.context); - this.accountUserProfiles = new Resource$Accountuserprofiles(this.context); - this.ads = new Resource$Ads(this.context); - this.advertiserGroups = new Resource$Advertisergroups(this.context); - this.advertiserLandingPages = new Resource$Advertiserlandingpages( - this.context - ); - this.advertisers = new Resource$Advertisers(this.context); - this.browsers = new Resource$Browsers(this.context); - this.campaignCreativeAssociations = new Resource$Campaigncreativeassociations( - this.context - ); - this.campaigns = new Resource$Campaigns(this.context); - this.changeLogs = new Resource$Changelogs(this.context); - this.cities = new Resource$Cities(this.context); - this.connectionTypes = new Resource$Connectiontypes(this.context); - this.contentCategories = new Resource$Contentcategories(this.context); - this.conversions = new Resource$Conversions(this.context); - this.countries = new Resource$Countries(this.context); - this.creativeAssets = new Resource$Creativeassets(this.context); - this.creativeFields = new Resource$Creativefields(this.context); - this.creativeFieldValues = new Resource$Creativefieldvalues(this.context); - this.creativeGroups = new Resource$Creativegroups(this.context); - this.creatives = new Resource$Creatives(this.context); - this.dimensionValues = new Resource$Dimensionvalues(this.context); - this.directorySiteContacts = new Resource$Directorysitecontacts( - this.context - ); - this.directorySites = new Resource$Directorysites(this.context); - this.dynamicTargetingKeys = new Resource$Dynamictargetingkeys( - this.context - ); - this.eventTags = new Resource$Eventtags(this.context); - this.files = new Resource$Files(this.context); - this.floodlightActivities = new Resource$Floodlightactivities( - this.context - ); - this.floodlightActivityGroups = new Resource$Floodlightactivitygroups( - this.context - ); - this.floodlightConfigurations = new Resource$Floodlightconfigurations( - this.context - ); - this.inventoryItems = new Resource$Inventoryitems(this.context); - this.languages = new Resource$Languages(this.context); - this.metros = new Resource$Metros(this.context); - this.mobileApps = new Resource$Mobileapps(this.context); - this.mobileCarriers = new Resource$Mobilecarriers(this.context); - this.operatingSystems = new Resource$Operatingsystems(this.context); - this.operatingSystemVersions = new Resource$Operatingsystemversions( - this.context - ); - this.orderDocuments = new Resource$Orderdocuments(this.context); - this.orders = new Resource$Orders(this.context); - this.placementGroups = new Resource$Placementgroups(this.context); - this.placements = new Resource$Placements(this.context); - this.placementStrategies = new Resource$Placementstrategies(this.context); - this.platformTypes = new Resource$Platformtypes(this.context); - this.postalCodes = new Resource$Postalcodes(this.context); - this.projects = new Resource$Projects(this.context); - this.regions = new Resource$Regions(this.context); - this.remarketingLists = new Resource$Remarketinglists(this.context); - this.remarketingListShares = new Resource$Remarketinglistshares( - this.context - ); - this.reports = new Resource$Reports(this.context); - this.sites = new Resource$Sites(this.context); - this.sizes = new Resource$Sizes(this.context); - this.subaccounts = new Resource$Subaccounts(this.context); - this.targetableRemarketingLists = new Resource$Targetableremarketinglists( - this.context - ); - this.targetingTemplates = new Resource$Targetingtemplates(this.context); - this.userProfiles = new Resource$Userprofiles(this.context); - this.userRolePermissionGroups = new Resource$Userrolepermissiongroups( - this.context - ); - this.userRolePermissions = new Resource$Userrolepermissions(this.context); - this.userRoles = new Resource$Userroles(this.context); - this.videoFormats = new Resource$Videoformats(this.context); - } - } - - /** - * Contains properties of a Campaign Manager account. - */ - export interface Schema$Account { - /** - * Account permissions assigned to this account. - */ - accountPermissionIds?: string[] | null; - /** - * Profile for this account. This is a read-only field that can be left blank. - */ - accountProfile?: string | null; - /** - * Whether this account is active. - */ - active?: boolean | null; - /** - * Maximum number of active ads allowed for this account. - */ - activeAdsLimitTier?: string | null; - /** - * Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. - */ - activeViewOptOut?: boolean | null; - /** - * User role permissions available to the user roles of this account. - */ - availablePermissionIds?: string[] | null; - /** - * ID of the country associated with this account. - */ - countryId?: string | null; - /** - * ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - */ - currencyId?: string | null; - /** - * Default placement dimensions for this account. - */ - defaultCreativeSizeId?: string | null; - /** - * Description of this account. - */ - description?: string | null; - /** - * ID of this account. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#account". - */ - kind?: string | null; - /** - * Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) - */ - locale?: string | null; - /** - * Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. - */ - maximumImageSize?: string | null; - /** - * Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. - */ - name?: string | null; - /** - * Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. - */ - nielsenOcrEnabled?: boolean | null; - /** - * Reporting configuration of this account. - */ - reportsConfiguration?: Schema$ReportsConfiguration; - /** - * Share Path to Conversion reports with Twitter. - */ - shareReportsWithTwitter?: boolean | null; - /** - * File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. - */ - teaserSizeLimit?: string | null; - } - /** - * Gets a summary of active ads in an account. - */ - export interface Schema$AccountActiveAdSummary { - /** - * ID of the account. - */ - accountId?: string | null; - /** - * Ads that have been activated for the account - */ - activeAds?: string | null; - /** - * Maximum number of active ads allowed for the account. - */ - activeAdsLimitTier?: string | null; - /** - * Ads that can be activated for the account. - */ - availableAds?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary". - */ - kind?: string | null; - } - /** - * AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account. - */ - export interface Schema$AccountPermission { - /** - * Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD" - */ - accountProfiles?: string[] | null; - /** - * ID of this account permission. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission". - */ - kind?: string | null; - /** - * Administrative level required to enable this account permission. - */ - level?: string | null; - /** - * Name of this account permission. - */ - name?: string | null; - /** - * Permission group of this account permission. - */ - permissionGroupId?: string | null; - } - /** - * AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions. - */ - export interface Schema$AccountPermissionGroup { - /** - * ID of this account permission group. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup". - */ - kind?: string | null; - /** - * Name of this account permission group. - */ - name?: string | null; - } - /** - * Account Permission Group List Response - */ - export interface Schema$AccountPermissionGroupsListResponse { - /** - * Account permission group collection. - */ - accountPermissionGroups?: Schema$AccountPermissionGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse". - */ - kind?: string | null; - } - /** - * Account Permission List Response - */ - export interface Schema$AccountPermissionsListResponse { - /** - * Account permission collection. - */ - accountPermissions?: Schema$AccountPermission[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse". - */ - kind?: string | null; - } - /** - * Account List Response - */ - export interface Schema$AccountsListResponse { - /** - * Account collection. - */ - accounts?: Schema$Account[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API. - */ - export interface Schema$AccountUserProfile { - /** - * Account ID of the user profile. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. - */ - active?: boolean | null; - /** - * Filter that describes which advertisers are visible to the user profile. - */ - advertiserFilter?: Schema$ObjectFilter; - /** - * Filter that describes which campaigns are visible to the user profile. - */ - campaignFilter?: Schema$ObjectFilter; - /** - * Comments for this user profile. - */ - comments?: string | null; - /** - * Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion. - */ - email?: string | null; - /** - * ID of the user profile. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile". - */ - kind?: string | null; - /** - * Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional) - */ - locale?: string | null; - /** - * Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,". - */ - name?: string | null; - /** - * Filter that describes which sites are visible to the user profile. - */ - siteFilter?: Schema$ObjectFilter; - /** - * Subaccount ID of the user profile. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Trafficker type of this user profile. This is a read-only field. - */ - traffickerType?: string | null; - /** - * User type of the user profile. This is a read-only field that can be left blank. - */ - userAccessType?: string | null; - /** - * Filter that describes which user roles are visible to the user profile. - */ - userRoleFilter?: Schema$ObjectFilter; - /** - * User role ID of the user profile. This is a required field. - */ - userRoleId?: string | null; - } - /** - * Account User Profile List Response - */ - export interface Schema$AccountUserProfilesListResponse { - /** - * Account user profile collection. - */ - accountUserProfiles?: Schema$AccountUserProfile[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Represents an activity group. - */ - export interface Schema$Activities { - /** - * List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup". - */ - filters?: Schema$DimensionValue[]; - /** - * The kind of resource this is, in this case dfareporting#activities. - */ - kind?: string | null; - /** - * List of names of floodlight activity metrics. - */ - metricNames?: string[] | null; - } - /** - * Contains properties of a Campaign Manager ad. - */ - export interface Schema$Ad { - /** - * Account ID of this ad. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Whether this ad is active. When true, archived must be false. - */ - active?: boolean | null; - /** - * Advertiser ID of this ad. This is a required field on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this ad is archived. When true, active must be false. - */ - archived?: boolean | null; - /** - * Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD. - */ - audienceSegmentId?: string | null; - /** - * Campaign ID of this ad. This is a required field on insertion. - */ - campaignId?: string | null; - /** - * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative. - */ - clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; - /** - * Comments for this ad. - */ - comments?: string | null; - /** - * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard. - */ - compatibility?: string | null; - /** - * Information about the creation of this ad. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments. - */ - creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; - /** - * Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment. - */ - creativeRotation?: Schema$CreativeRotation; - /** - * Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - dayPartTargeting?: Schema$DayPartTargeting; - /** - * Default click-through event tag properties for this ad. - */ - defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; - /** - * Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD. - */ - deliverySchedule?: Schema$DeliverySchedule; - /** - * Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert. - */ - dynamicClickTracker?: boolean | null; - /** - * Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion. - */ - endTime?: string | null; - /** - * Event tag overrides for this ad. - */ - eventTagOverrides?: Schema$EventTagOverride[]; - /** - * Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - geoTargeting?: Schema$GeoTargeting; - /** - * ID of this ad. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this ad. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad". - */ - kind?: string | null; - /** - * Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - languageTargeting?: Schema$LanguageTargeting; - /** - * Information about the most recent modification of this ad. This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this ad. This is a required field and must be less than 256 characters long. - */ - name?: string | null; - /** - * Placement assignments for this ad. - */ - placementAssignments?: Schema$PlacementAssignment[]; - /** - * Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - remarketingListExpression?: Schema$ListTargetingExpression; - /** - * Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. - */ - size?: Schema$Size; - /** - * Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. - */ - sslCompliant?: boolean | null; - /** - * Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated. - */ - sslRequired?: boolean | null; - /** - * Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion. - */ - startTime?: string | null; - /** - * Subaccount ID of this ad. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. - */ - targetingTemplateId?: string | null; - /** - * Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD. - */ - technologyTargeting?: Schema$TechnologyTargeting; - /** - * Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). - */ - type?: string | null; - } - /** - * Campaign ad blocking settings. - */ - export interface Schema$AdBlockingConfiguration { - /** - * Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. - */ - clickThroughUrl?: string | null; - /** - * ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. - */ - creativeBundleId?: string | null; - /** - * Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. - */ - enabled?: boolean | null; - /** - * Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. - */ - overrideClickThroughUrl?: boolean | null; - } - /** - * Ad List Response - */ - export interface Schema$AdsListResponse { - /** - * Ad collection. - */ - ads?: Schema$Ad[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Ad Slot - */ - export interface Schema$AdSlot { - /** - * Comment for this ad slot. - */ - comment?: string | null; - /** - * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. - */ - compatibility?: string | null; - /** - * Height of this ad slot. - */ - height?: string | null; - /** - * ID of the placement from an external platform that is linked to this ad slot. - */ - linkedPlacementId?: string | null; - /** - * Name of this ad slot. - */ - name?: string | null; - /** - * Payment source type of this ad slot. - */ - paymentSourceType?: string | null; - /** - * Primary ad slot of a roadblock inventory item. - */ - primary?: boolean | null; - /** - * Width of this ad slot. - */ - width?: string | null; - } - /** - * Contains properties of a Campaign Manager advertiser. - */ - export interface Schema$Advertiser { - /** - * Account ID of this advertiser.This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. - */ - advertiserGroupId?: string | null; - /** - * Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. - */ - clickThroughUrlSuffix?: string | null; - /** - * ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. - */ - defaultClickThroughEventTagId?: string | null; - /** - * Default email address used in sender field for tag emails. - */ - defaultEmail?: string | null; - /** - * Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser. - */ - floodlightConfigurationId?: string | null; - /** - * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this advertiser. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this advertiser. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser". - */ - kind?: string | null; - /** - * Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. - */ - name?: string | null; - /** - * Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. - */ - originalFloodlightConfigurationId?: string | null; - /** - * Status of this advertiser. - */ - status?: string | null; - /** - * Subaccount ID of this advertiser.This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Suspension status of this advertiser. - */ - suspended?: boolean | null; - } - /** - * Groups advertisers together so that reports can be generated for the entire group at once. - */ - export interface Schema$AdvertiserGroup { - /** - * Account ID of this advertiser group. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * ID of this advertiser group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup". - */ - kind?: string | null; - /** - * Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account. - */ - name?: string | null; - } - /** - * Advertiser Group List Response - */ - export interface Schema$AdvertiserGroupsListResponse { - /** - * Advertiser group collection. - */ - advertiserGroups?: Schema$AdvertiserGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Landing Page List Response - */ - export interface Schema$AdvertiserLandingPagesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse". - */ - kind?: string | null; - /** - * Landing page collection - */ - landingPages?: Schema$LandingPage[]; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Advertiser List Response - */ - export interface Schema$AdvertisersListResponse { - /** - * Advertiser collection. - */ - advertisers?: Schema$Advertiser[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Audience Segment. - */ - export interface Schema$AudienceSegment { - /** - * Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. - */ - allocation?: number | null; - /** - * ID of this audience segment. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Name of this audience segment. This is a required field and must be less than 65 characters long. - */ - name?: string | null; - } - /** - * Audience Segment Group. - */ - export interface Schema$AudienceSegmentGroup { - /** - * Audience segments assigned to this group. The number of segments must be between 2 and 100. - */ - audienceSegments?: Schema$AudienceSegment[]; - /** - * ID of this audience segment group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Name of this audience segment group. This is a required field and must be less than 65 characters long. - */ - name?: string | null; - } - /** - * Contains information about a browser that can be targeted by ads. - */ - export interface Schema$Browser { - /** - * ID referring to this grouping of browser and version numbers. This is the ID used for targeting. - */ - browserVersionId?: string | null; - /** - * DART ID of this browser. This is the ID used when generating reports. - */ - dartId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser". - */ - kind?: string | null; - /** - * Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. - */ - majorVersion?: string | null; - /** - * Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is. - */ - minorVersion?: string | null; - /** - * Name of this browser. - */ - name?: string | null; - } - /** - * Browser List Response - */ - export interface Schema$BrowsersListResponse { - /** - * Browser collection. - */ - browsers?: Schema$Browser[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse". - */ - kind?: string | null; - } - /** - * Contains properties of a Campaign Manager campaign. - */ - export interface Schema$Campaign { - /** - * Account ID of this campaign. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Ad blocking settings for this campaign. - */ - adBlockingConfiguration?: Schema$AdBlockingConfiguration; - /** - * Additional creative optimization configurations for the campaign. - */ - additionalCreativeOptimizationConfigurations?: Schema$CreativeOptimizationConfiguration[]; - /** - * Advertiser group ID of the associated advertiser. - */ - advertiserGroupId?: string | null; - /** - * Advertiser ID of this campaign. This is a required field. - */ - advertiserId?: string | null; - /** - * Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this campaign has been archived. - */ - archived?: boolean | null; - /** - * Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. - */ - audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; - /** - * Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. - */ - billingInvoiceCode?: string | null; - /** - * Click-through URL suffix override properties for this campaign. - */ - clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; - /** - * Arbitrary comments about this campaign. Must be less than 256 characters long. - */ - comment?: string | null; - /** - * Information about the creation of this campaign. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * List of creative group IDs that are assigned to the campaign. - */ - creativeGroupIds?: string[] | null; - /** - * Creative optimization configuration for the campaign. - */ - creativeOptimizationConfiguration?: Schema$CreativeOptimizationConfiguration; - /** - * Click-through event tag ID override properties for this campaign. - */ - defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties; - /** - * The default landing page ID for this campaign. - */ - defaultLandingPageId?: string | null; - /** - * Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field. - */ - endDate?: string | null; - /** - * Overrides that can be used to activate or deactivate advertiser event tags. - */ - eventTagOverrides?: Schema$EventTagOverride[]; - /** - * External ID for this campaign. - */ - externalId?: string | null; - /** - * ID of this campaign. This is a read-only auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this campaign. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". - */ - kind?: string | null; - /** - * Information about the most recent modification of this campaign. This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Lookback window settings for the campaign. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. - */ - name?: string | null; - /** - * Whether Nielsen reports are enabled for this campaign. - */ - nielsenOcrEnabled?: boolean | null; - /** - * Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field. - */ - startDate?: string | null; - /** - * Subaccount ID of this campaign. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Campaign trafficker contact emails. - */ - traffickerEmails?: string[] | null; - } - /** - * Identifies a creative which has been associated with a given campaign. - */ - export interface Schema$CampaignCreativeAssociation { - /** - * ID of the creative associated with the campaign. This is a required field. - */ - creativeId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation". - */ - kind?: string | null; - } - /** - * Campaign Creative Association List Response - */ - export interface Schema$CampaignCreativeAssociationsListResponse { - /** - * Campaign creative association collection - */ - campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Campaign List Response - */ - export interface Schema$CampaignsListResponse { - /** - * Campaign collection. - */ - campaigns?: Schema$Campaign[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Describes a change that a user has made to a resource. - */ - export interface Schema$ChangeLog { - /** - * Account ID of the modified object. - */ - accountId?: string | null; - /** - * Action which caused the change. - */ - action?: string | null; - /** - * Time when the object was modified. - */ - changeTime?: string | null; - /** - * Field name of the object which changed. - */ - fieldName?: string | null; - /** - * ID of this change log. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". - */ - kind?: string | null; - /** - * New value of the object field. - */ - newValue?: string | null; - /** - * ID of the object of this change log. The object could be a campaign, placement, ad, or other type. - */ - objectId?: string | null; - /** - * Object type of the change log. - */ - objectType?: string | null; - /** - * Old value of the object field. - */ - oldValue?: string | null; - /** - * Subaccount ID of the modified object. - */ - subaccountId?: string | null; - /** - * Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. - */ - transactionId?: string | null; - /** - * ID of the user who modified the object. - */ - userProfileId?: string | null; - /** - * User profile name of the user who modified the object. - */ - userProfileName?: string | null; - } - /** - * Change Log List Response - */ - export interface Schema$ChangeLogsListResponse { - /** - * Change log collection. - */ - changeLogs?: Schema$ChangeLog[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * City List Response - */ - export interface Schema$CitiesListResponse { - /** - * City collection. - */ - cities?: Schema$City[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse". - */ - kind?: string | null; - } - /** - * Contains information about a city that can be targeted by ads. - */ - export interface Schema$City { - /** - * Country code of the country to which this city belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this city belongs. - */ - countryDartId?: string | null; - /** - * DART ID of this city. This is the ID used for targeting and generating reports. - */ - dartId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#city". - */ - kind?: string | null; - /** - * Metro region code of the metro region (DMA) to which this city belongs. - */ - metroCode?: string | null; - /** - * ID of the metro region (DMA) to which this city belongs. - */ - metroDmaId?: string | null; - /** - * Name of this city. - */ - name?: string | null; - /** - * Region code of the region to which this city belongs. - */ - regionCode?: string | null; - /** - * DART ID of the region to which this city belongs. - */ - regionDartId?: string | null; - } - /** - * Creative Click Tag. - */ - export interface Schema$ClickTag { - /** - * Parameter value for the specified click tag. This field contains a click-through url. - */ - clickThroughUrl?: Schema$CreativeClickThroughUrl; - /** - * Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - eventName?: string | null; - /** - * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field. - */ - name?: string | null; - } - /** - * Click-through URL - */ - export interface Schema$ClickThroughUrl { - /** - * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field. - */ - computedClickThroughUrl?: string | null; - /** - * Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset. - */ - customClickThroughUrl?: string | null; - /** - * Whether the campaign default landing page is used. - */ - defaultLandingPage?: boolean | null; - /** - * ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false. - */ - landingPageId?: string | null; - } - /** - * Click Through URL Suffix settings. - */ - export interface Schema$ClickThroughUrlSuffixProperties { - /** - * Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. - */ - clickThroughUrlSuffix?: string | null; - /** - * Whether this entity should override the inherited click-through URL suffix with its own defined value. - */ - overrideInheritedSuffix?: boolean | null; - } - /** - * Companion Click-through override. - */ - export interface Schema$CompanionClickThroughOverride { - /** - * Click-through URL of this companion click-through override. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * ID of the creative for this companion click-through override. - */ - creativeId?: string | null; - } - /** - * Companion Settings - */ - export interface Schema$CompanionSetting { - /** - * Whether companions are disabled for this placement. - */ - companionsDisabled?: boolean | null; - /** - * Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. - */ - enabledSizes?: Schema$Size[]; - /** - * Whether to serve only static images as companions. - */ - imageOnly?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". - */ - kind?: string | null; - } - /** - * Represents a response to the queryCompatibleFields method. - */ - export interface Schema$CompatibleFields { - /** - * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". - */ - crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". - */ - floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; - /** - * The kind of resource this is, in this case dfareporting#compatibleFields. - */ - kind?: string | null; - /** - * Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". - */ - pathToConversionReportCompatibleFields?: Schema$PathToConversionReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type "REACH". - */ - reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; - /** - * Contains items that are compatible to be selected for a report of type "STANDARD". - */ - reportCompatibleFields?: Schema$ReportCompatibleFields; - } - /** - * Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users. - */ - export interface Schema$ConnectionType { - /** - * ID of this connection type. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType". - */ - kind?: string | null; - /** - * Name of this connection type. - */ - name?: string | null; - } - /** - * Connection Type List Response - */ - export interface Schema$ConnectionTypesListResponse { - /** - * Collection of connection types such as broadband and mobile. - */ - connectionTypes?: Schema$ConnectionType[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse". - */ - kind?: string | null; - } - /** - * Content Category List Response - */ - export interface Schema$ContentCategoriesListResponse { - /** - * Content category collection. - */ - contentCategories?: Schema$ContentCategory[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Organizes placements according to the contents of their associated webpages. - */ - export interface Schema$ContentCategory { - /** - * Account ID of this content category. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * ID of this content category. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory". - */ - kind?: string | null; - /** - * Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account. - */ - name?: string | null; - } - /** - * A Conversion represents when a user successfully performs a desired action after seeing an ad. - */ - export interface Schema$Conversion { - /** - * Whether this particular request may come from a user under the age of 13, under COPPA compliance. - */ - childDirectedTreatment?: boolean | null; - /** - * Custom floodlight variables. - */ - customVariables?: Schema$CustomFloodlightVariable[]; - /** - * The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field. - */ - encryptedUserId?: string | null; - /** - * A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field. - */ - encryptedUserIdCandidates?: string[] | null; - /** - * Floodlight Activity ID of this conversion. This is a required field. - */ - floodlightActivityId?: string | null; - /** - * Floodlight Configuration ID of this conversion. This is a required field. - */ - floodlightConfigurationId?: string | null; - /** - * The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field. - */ - gclid?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion". - */ - kind?: string | null; - /** - * Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing. - */ - limitAdTracking?: boolean | null; - /** - * The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field. - */ - mobileDeviceId?: string | null; - /** - * Whether the conversion was for a non personalized ad. - */ - nonPersonalizedAd?: boolean | null; - /** - * The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field. - */ - ordinal?: string | null; - /** - * The quantity of the conversion. - */ - quantity?: string | null; - /** - * The timestamp of conversion, in Unix epoch micros. This is a required field. - */ - timestampMicros?: string | null; - /** - * Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR). - */ - treatmentForUnderage?: boolean | null; - /** - * The value of the conversion. - */ - value?: number | null; - } - /** - * The error code and description for a conversion that failed to insert or update. - */ - export interface Schema$ConversionError { - /** - * The error code. - */ - code?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". - */ - kind?: string | null; - /** - * A description of the error. - */ - message?: string | null; - } - /** - * Insert Conversions Request. - */ - export interface Schema$ConversionsBatchInsertRequest { - /** - * The set of conversions to insert. - */ - conversions?: Schema$Conversion[]; - /** - * Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used. - */ - encryptionInfo?: Schema$EncryptionInfo; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest". - */ - kind?: string | null; - } - /** - * Insert Conversions Response. - */ - export interface Schema$ConversionsBatchInsertResponse { - /** - * Indicates that some or all conversions failed to insert. - */ - hasFailures?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse". - */ - kind?: string | null; - /** - * The insert status of each conversion. Statuses are returned in the same order that conversions are inserted. - */ - status?: Schema$ConversionStatus[]; - } - /** - * Update Conversions Request. - */ - export interface Schema$ConversionsBatchUpdateRequest { - /** - * The set of conversions to update. - */ - conversions?: Schema$Conversion[]; - /** - * Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used. - */ - encryptionInfo?: Schema$EncryptionInfo; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest". - */ - kind?: string | null; - } - /** - * Update Conversions Response. - */ - export interface Schema$ConversionsBatchUpdateResponse { - /** - * Indicates that some or all conversions failed to update. - */ - hasFailures?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse". - */ - kind?: string | null; - /** - * The update status of each conversion. Statuses are returned in the same order that conversions are updated. - */ - status?: Schema$ConversionStatus[]; - } - /** - * The original conversion that was inserted or updated and whether there were any errors. - */ - export interface Schema$ConversionStatus { - /** - * The original conversion that was inserted or updated. - */ - conversion?: Schema$Conversion; - /** - * A list of errors related to this conversion. - */ - errors?: Schema$ConversionError[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus". - */ - kind?: string | null; - } - /** - * Country List Response - */ - export interface Schema$CountriesListResponse { - /** - * Country collection. - */ - countries?: Schema$Country[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse". - */ - kind?: string | null; - } - /** - * Contains information about a country that can be targeted by ads. - */ - export interface Schema$Country { - /** - * Country code. - */ - countryCode?: string | null; - /** - * DART ID of this country. This is the ID used for targeting and generating reports. - */ - dartId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#country". - */ - kind?: string | null; - /** - * Name of this country. - */ - name?: string | null; - /** - * Whether ad serving supports secure servers in this country. - */ - sslEnabled?: boolean | null; - } - /** - * Contains properties of a Creative. - */ - export interface Schema$Creative { - /** - * Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. - */ - accountId?: string | null; - /** - * Whether the creative is active. Applicable to all creative types. - */ - active?: boolean | null; - /** - * Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE. - */ - additionalSizes?: Schema$Size[]; - /** - * Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. - */ - adParameters?: string | null; - /** - * Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - adTagKeys?: string[] | null; - /** - * Advertiser ID of this creative. This is a required field. Applicable to all creative types. - */ - advertiserId?: string | null; - /** - * Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. - */ - allowScriptAccess?: boolean | null; - /** - * Whether the creative is archived. Applicable to all creative types. - */ - archived?: boolean | null; - /** - * Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - artworkType?: string | null; - /** - * Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. - */ - authoringSource?: string | null; - /** - * Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - */ - authoringTool?: string | null; - /** - * Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. - */ - autoAdvanceImages?: boolean | null; - /** - * The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. - */ - backgroundColor?: string | null; - /** - * Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. - */ - backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl; - /** - * List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - backupImageFeatures?: string[] | null; - /** - * Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. - */ - backupImageReportingLabel?: string | null; - /** - * Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - backupImageTargetWindow?: Schema$TargetWindow; - /** - * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - clickTags?: Schema$ClickTag[]; - /** - * Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. - */ - commercialId?: string | null; - /** - * List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. - */ - companionCreatives?: string[] | null; - /** - * Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" - */ - compatibility?: string[] | null; - /** - * Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - convertFlashToHtml5?: boolean | null; - /** - * List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. - */ - counterCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT - */ - creativeAssets?: Schema$CreativeAsset[]; - /** - * Required if dynamicAssetSelection is true. - */ - creativeAssetSelection?: Schema$CreativeAssetSelection; - /** - * Creative field assignments for this creative. Applicable to all creative types. - */ - creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; - /** - * Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - customKeyValues?: string[] | null; - /** - * Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives. - */ - dynamicAssetSelection?: boolean | null; - /** - * List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - exitCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE. - */ - fsCommand?: Schema$FsCommand; - /** - * HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. - */ - htmlCode?: string | null; - /** - * Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. - */ - htmlCodeLocked?: boolean | null; - /** - * ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. - */ - id?: string | null; - /** - * Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". - */ - kind?: string | null; - /** - * Creative last modification information. This is a read-only field. Applicable to all creative types. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - latestTraffickedCreativeId?: string | null; - /** - * Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. - */ - mediaDescription?: string | null; - /** - * Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. - */ - mediaDuration?: number | null; - /** - * Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types. - */ - name?: string | null; - /** - * Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. - */ - overrideCss?: string | null; - /** - * The asset ID of the polite load image asset. Applicable to the creative type: DISPLAY. - */ - politeLoadAssetId?: string | null; - /** - * Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO. - */ - progressOffset?: Schema$VideoOffset; - /** - * URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT - */ - redirectUrl?: string | null; - /** - * ID of current rendering version. This is a read-only field. Applicable to all creative types. - */ - renderingId?: string | null; - /** - * Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types. - */ - renderingIdDimensionValue?: Schema$DimensionValue; - /** - * The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - requiredFlashPluginVersion?: string | null; - /** - * The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - requiredFlashVersion?: number | null; - /** - * Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. - */ - size?: Schema$Size; - /** - * Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO. - */ - skipOffset?: Schema$VideoOffset; - /** - * Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. - */ - skippable?: boolean | null; - /** - * Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. - */ - sslCompliant?: boolean | null; - /** - * Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. - */ - sslOverride?: boolean | null; - /** - * Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - studioAdvertiserId?: string | null; - /** - * Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - studioCreativeId?: string | null; - /** - * Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - studioTraffickedCreativeId?: string | null; - /** - * Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. - */ - subaccountId?: string | null; - /** - * Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. - */ - thirdPartyBackupImageImpressionsUrl?: string | null; - /** - * Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. - */ - thirdPartyRichMediaImpressionsUrl?: string | null; - /** - * Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. - */ - thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; - /** - * List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. - */ - timerCustomEvents?: Schema$CreativeCustomEvent[]; - /** - * Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - */ - totalFileSize?: string | null; - /** - * Type of this creative. This is a required field. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. - */ - type?: string | null; - /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. - */ - universalAdId?: Schema$UniversalAdId; - /** - * The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. - */ - version?: number | null; - } - /** - * Creative Asset. - */ - export interface Schema$CreativeAsset { - /** - * Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - actionScript3?: boolean | null; - /** - * Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - */ - active?: boolean | null; - /** - * Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render. - */ - additionalSizes?: Schema$Size[]; - /** - * Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. - */ - alignment?: string | null; - /** - * Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - artworkType?: string | null; - /** - * Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - assetIdentifier?: Schema$CreativeAssetId; - /** - * Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA. - */ - backupImageExit?: Schema$CreativeCustomEvent; - /** - * Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - */ - bitRate?: number | null; - /** - * Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. - */ - childAssetType?: string | null; - /** - * Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. - */ - collapsedSize?: Schema$Size; - /** - * List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true. - */ - companionCreativeIds?: string[] | null; - /** - * Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0. - */ - customStartTimeValue?: number | null; - /** - * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - detectedFeatures?: string[] | null; - /** - * Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - displayType?: string | null; - /** - * Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. - */ - duration?: number | null; - /** - * Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. - */ - durationType?: string | null; - /** - * Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - expandedDimension?: Schema$Size; - /** - * File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - fileSize?: string | null; - /** - * Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - flashVersion?: number | null; - /** - * Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. - */ - hideFlashObjects?: boolean | null; - /** - * Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. - */ - hideSelectionBoxes?: boolean | null; - /** - * Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - horizontallyLocked?: boolean | null; - /** - * Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - id?: string | null; - /** - * Dimension value for the ID of the asset. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - */ - mediaDuration?: number | null; - /** - * Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - */ - mimeType?: string | null; - /** - * Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. - */ - offset?: Schema$OffsetPosition; - /** - * Orientation of video asset. This is a read-only, auto-generated field. - */ - orientation?: string | null; - /** - * Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA. - */ - originalBackup?: boolean | null; - /** - * Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA. - */ - position?: Schema$OffsetPosition; - /** - * Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - positionLeftUnit?: string | null; - /** - * Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA. - */ - positionTopUnit?: string | null; - /** - * Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - progressiveServingUrl?: string | null; - /** - * Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. - */ - pushdown?: boolean | null; - /** - * Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive. - */ - pushdownDuration?: number | null; - /** - * Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. - */ - role?: string | null; - /** - * Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - */ - size?: Schema$Size; - /** - * Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - */ - sslCompliant?: boolean | null; - /** - * Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. - */ - startTimeType?: string | null; - /** - * Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - streamingServingUrl?: string | null; - /** - * Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. - */ - transparency?: boolean | null; - /** - * Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - */ - verticallyLocked?: boolean | null; - /** - * Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. - */ - windowMode?: string | null; - /** - * zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive. - */ - zIndex?: number | null; - /** - * File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - */ - zipFilename?: string | null; - /** - * Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - */ - zipFilesize?: string | null; - } - /** - * Creative Asset ID. - */ - export interface Schema$CreativeAssetId { - /** - * Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed. - */ - name?: string | null; - /** - * Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE. - */ - type?: string | null; - } - /** - * CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative. - */ - export interface Schema$CreativeAssetMetadata { - /** - * ID of the creative asset. This is a required field. - */ - assetIdentifier?: Schema$CreativeAssetId; - /** - * List of detected click tags for assets. This is a read-only auto-generated field. - */ - clickTags?: Schema$ClickTag[]; - /** - * List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. - */ - detectedFeatures?: string[] | null; - /** - * Numeric ID of the asset. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata". - */ - kind?: string | null; - /** - * Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID" - */ - warnedValidationRules?: string[] | null; - } - /** - * Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. - */ - export interface Schema$CreativeAssetSelection { - /** - * A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field. - */ - defaultAssetId?: string | null; - /** - * Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. - */ - rules?: Schema$Rule[]; - } - /** - * Creative Assignment. - */ - export interface Schema$CreativeAssignment { - /** - * Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. - */ - active?: boolean | null; - /** - * Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. - */ - applyEventTags?: boolean | null; - /** - * Click-through URL of the creative assignment. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Companion creative overrides for this creative assignment. Applicable to video ads. - */ - companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; - /** - * Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. - */ - creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; - /** - * ID of the creative to be assigned. This is a required field. - */ - creativeId?: string | null; - /** - * Dimension value for the ID of the creative. This is a read-only, auto-generated field. - */ - creativeIdDimensionValue?: Schema$DimensionValue; - /** - * Date and time that the assigned creative should stop serving. Must be later than the start time. - */ - endTime?: string | null; - /** - * Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR - */ - richMediaExitOverrides?: Schema$RichMediaExitOverride[]; - /** - * Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive. - */ - sequence?: number | null; - /** - * Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. - */ - sslCompliant?: boolean | null; - /** - * Date and time that the assigned creative should start serving. - */ - startTime?: string | null; - /** - * Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. - */ - weight?: number | null; - } - /** - * Click-through URL - */ - export interface Schema$CreativeClickThroughUrl { - /** - * Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. - */ - computedClickThroughUrl?: string | null; - /** - * Custom click-through URL. Applicable if the landingPageId field is left unset. - */ - customClickThroughUrl?: string | null; - /** - * ID of the landing page for the click-through URL. - */ - landingPageId?: string | null; - } - /** - * Creative Custom Event. - */ - export interface Schema$CreativeCustomEvent { - /** - * Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. - */ - advertiserCustomEventId?: string | null; - /** - * User-entered name for the event. - */ - advertiserCustomEventName?: string | null; - /** - * Type of the event. This is a read-only field. - */ - advertiserCustomEventType?: string | null; - /** - * Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. - */ - artworkLabel?: string | null; - /** - * Artwork type used by the creative.This is a read-only field. - */ - artworkType?: string | null; - /** - * Exit click-through URL for the event. This field is used only for exit events. - */ - exitClickThroughUrl?: Schema$CreativeClickThroughUrl; - /** - * ID of this event. This is a required field and should not be modified after insertion. - */ - id?: string | null; - /** - * Properties for rich media popup windows. This field is used only for exit events. - */ - popupWindowProperties?: Schema$PopupWindowProperties; - /** - * Target type used by the event. - */ - targetType?: string | null; - /** - * Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. - */ - videoReportingId?: string | null; - } - /** - * Contains properties of a creative field. - */ - export interface Schema$CreativeField { - /** - * Account ID of this creative field. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this creative field. This is a required field on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this creative field. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField". - */ - kind?: string | null; - /** - * Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser. - */ - name?: string | null; - /** - * Subaccount ID of this creative field. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Creative Field Assignment. - */ - export interface Schema$CreativeFieldAssignment { - /** - * ID of the creative field. - */ - creativeFieldId?: string | null; - /** - * ID of the creative field value. - */ - creativeFieldValueId?: string | null; - } - /** - * Creative Field List Response - */ - export interface Schema$CreativeFieldsListResponse { - /** - * Creative field collection. - */ - creativeFields?: Schema$CreativeField[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains properties of a creative field value. - */ - export interface Schema$CreativeFieldValue { - /** - * ID of this creative field value. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue". - */ - kind?: string | null; - /** - * Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field. - */ - value?: string | null; - } - /** - * Creative Field Value List Response - */ - export interface Schema$CreativeFieldValuesListResponse { - /** - * Creative field value collection. - */ - creativeFieldValues?: Schema$CreativeFieldValue[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains properties of a creative group. - */ - export interface Schema$CreativeGroup { - /** - * Account ID of this creative group. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this creative group. This is a required field on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive. - */ - groupNumber?: number | null; - /** - * ID of this creative group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup". - */ - kind?: string | null; - /** - * Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser. - */ - name?: string | null; - /** - * Subaccount ID of this creative group. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Creative Group Assignment. - */ - export interface Schema$CreativeGroupAssignment { - /** - * ID of the creative group to be assigned. - */ - creativeGroupId?: string | null; - /** - * Creative group number of the creative group assignment. - */ - creativeGroupNumber?: string | null; - } - /** - * Creative Group List Response - */ - export interface Schema$CreativeGroupsListResponse { - /** - * Creative group collection. - */ - creativeGroups?: Schema$CreativeGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Creative optimization settings. - */ - export interface Schema$CreativeOptimizationConfiguration { - /** - * ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. - */ - id?: string | null; - /** - * Name of this creative optimization config. This is a required field and must be less than 129 characters long. - */ - name?: string | null; - /** - * List of optimization activities associated with this configuration. - */ - optimizationActivitys?: Schema$OptimizationActivity[]; - /** - * Optimization model for this configuration. - */ - optimizationModel?: string | null; - } - /** - * Creative Rotation. - */ - export interface Schema$CreativeRotation { - /** - * Creative assignments in this creative rotation. - */ - creativeAssignments?: Schema$CreativeAssignment[]; - /** - * Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad. - */ - creativeOptimizationConfigurationId?: string | null; - /** - * Type of creative rotation. Can be used to specify whether to use sequential or random rotation. - */ - type?: string | null; - /** - * Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. - */ - weightCalculationStrategy?: string | null; - } - /** - * Creative Settings - */ - export interface Schema$CreativeSettings { - /** - * Header text for iFrames for this site. Must be less than or equal to 2000 characters long. - */ - iFrameFooter?: string | null; - /** - * Header text for iFrames for this site. Must be less than or equal to 2000 characters long. - */ - iFrameHeader?: string | null; - } - /** - * Creative List Response - */ - export interface Schema$CreativesListResponse { - /** - * Creative collection. - */ - creatives?: Schema$Creative[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". - */ - export interface Schema$CrossDimensionReachReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the "breakdown" section of the report. - */ - breakdown?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. - */ - overlapMetrics?: Schema$Metric[]; - } - /** - * A custom floodlight variable. - */ - export interface Schema$CustomFloodlightVariable { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". - */ - kind?: string | null; - /** - * The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags. - */ - type?: string | null; - /** - * The value of the custom floodlight variable. The length of string must not exceed 50 characters. - */ - value?: string | null; - } - /** - * Represents a Custom Rich Media Events group. - */ - export interface Schema$CustomRichMediaEvents { - /** - * List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName. - */ - filteredEventIds?: Schema$DimensionValue[]; - /** - * The kind of resource this is, in this case dfareporting#customRichMediaEvents. - */ - kind?: string | null; - } - /** - * Represents a date range. - */ - export interface Schema$DateRange { - /** - * The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd". - */ - endDate?: string | null; - /** - * The kind of resource this is, in this case dfareporting#dateRange. - */ - kind?: string | null; - /** - * The date range relative to the date of when the report is run. - */ - relativeDateRange?: string | null; - /** - * The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd". - */ - startDate?: string | null; - } - /** - * Day Part Targeting. - */ - export interface Schema$DayPartTargeting { - /** - * Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY" - */ - daysOfWeek?: string[] | null; - /** - * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. - */ - hoursOfDay?: number[] | null; - /** - * Whether or not to use the user's local time. If false, the America/New York time zone applies. - */ - userLocalTime?: boolean | null; - } - /** - * Contains information about a landing page deep link. - */ - export interface Schema$DeepLink { - /** - * The URL of the mobile app being linked to. - */ - appUrl?: string | null; - /** - * The fallback URL. This URL will be served to users who do not have the mobile app installed. - */ - fallbackUrl?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink". - */ - kind?: string | null; - /** - * The mobile app targeted by this deep link. - */ - mobileApp?: Schema$MobileApp; - /** - * Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE. - */ - remarketingListIds?: string[] | null; - } - /** - * Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. - */ - export interface Schema$DefaultClickThroughEventTagProperties { - /** - * ID of the click-through event tag to apply to all ads in this entity's scope. - */ - defaultClickThroughEventTagId?: string | null; - /** - * Whether this entity should override the inherited default click-through event tag with its own defined value. - */ - overrideInheritedEventTag?: boolean | null; - } - /** - * Delivery Schedule. - */ - export interface Schema$DeliverySchedule { - /** - * Limit on the number of times an individual user can be served the ad within a specified period of time. - */ - frequencyCap?: Schema$FrequencyCap; - /** - * Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals. - */ - hardCutoff?: boolean | null; - /** - * Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive. - */ - impressionRatio?: string | null; - /** - * Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served. - */ - priority?: string | null; - } - /** - * Google Ad Manager Settings - */ - export interface Schema$DfpSettings { - /** - * Ad Manager network code for this directory site. - */ - dfpNetworkCode?: string | null; - /** - * Ad Manager network name for this directory site. - */ - dfpNetworkName?: string | null; - /** - * Whether this directory site accepts programmatic placements. - */ - programmaticPlacementAccepted?: boolean | null; - /** - * Whether this directory site is available only via Publisher Portal. - */ - publisherPortalOnly?: boolean | null; - /** - * Whether this directory site accepts publisher-paid tags. - */ - pubPaidPlacementAccepted?: boolean | null; - } - /** - * Represents a dimension. - */ - export interface Schema$Dimension { - /** - * The kind of resource this is, in this case dfareporting#dimension. - */ - kind?: string | null; - /** - * The dimension name, e.g. dfa:advertiser - */ - name?: string | null; - } - /** - * Represents a dimension filter. - */ - export interface Schema$DimensionFilter { - /** - * The name of the dimension to filter. - */ - dimensionName?: string | null; - /** - * The kind of resource this is, in this case dfareporting#dimensionFilter. - */ - kind?: string | null; - /** - * The value of the dimension to filter. - */ - value?: string | null; - } - /** - * Represents a DimensionValue resource. - */ - export interface Schema$DimensionValue { - /** - * The name of the dimension. - */ - dimensionName?: string | null; - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The ID associated with the value if available. - */ - id?: string | null; - /** - * The kind of resource this is, in this case dfareporting#dimensionValue. - */ - kind?: string | null; - /** - * Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - */ - matchType?: string | null; - /** - * The value of the dimension. - */ - value?: string | null; - } - /** - * Represents the list of DimensionValue resources. - */ - export interface Schema$DimensionValueList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The dimension values returned in this response. - */ - items?: Schema$DimensionValue[]; - /** - * The kind of list this is, in this case dfareporting#dimensionValueList. - */ - kind?: string | null; - /** - * Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. - */ - nextPageToken?: string | null; - } - /** - * Represents a DimensionValuesRequest. - */ - export interface Schema$DimensionValueRequest { - /** - * The name of the dimension for which values should be requested. - */ - dimensionName?: string | null; - /** - * The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". - */ - endDate?: string | null; - /** - * The list of filters by which to filter values. The filters are ANDed. - */ - filters?: Schema$DimensionFilter[]; - /** - * The kind of request this is, in this case dfareporting#dimensionValueRequest. - */ - kind?: string | null; - /** - * The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". - */ - startDate?: string | null; - } - /** - * 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; - /** - * Directory site contacts. - */ - contactAssignments?: Schema$DirectorySiteContactAssignment[]; - /** - * Country ID of this directory site. This is a read-only field. - */ - countryId?: string | null; - /** - * Currency ID of this directory site. This is a read-only field. Possible values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - */ - currencyId?: string | null; - /** - * Description of this directory site. This is a read-only field. - */ - description?: string | null; - /** - * ID of this directory site. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this directory site. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" - */ - inpageTagFormats?: string[] | null; - /** - * Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL" - */ - interstitialTagFormats?: string[] | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite". - */ - kind?: string | null; - /** - * Name of this directory site. - */ - name?: string | null; - /** - * Parent directory site ID. - */ - parentId?: string | null; - /** - * Directory site settings. - */ - settings?: Schema$DirectorySiteSettings; - /** - * URL of this directory site. - */ - url?: string | null; - } - /** - * Contains properties of a Site Directory contact. - */ - export interface Schema$DirectorySiteContact { - /** - * Address of this directory site contact. - */ - address?: string | null; - /** - * Email address of this directory site contact. - */ - email?: string | null; - /** - * First name of this directory site contact. - */ - firstName?: string | null; - /** - * ID of this directory site contact. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact". - */ - kind?: string | null; - /** - * Last name of this directory site contact. - */ - lastName?: string | null; - /** - * Phone number of this directory site contact. - */ - phone?: string | null; - /** - * Directory site contact role. - */ - role?: string | null; - /** - * Title or designation of this directory site contact. - */ - title?: string | null; - /** - * Directory site contact type. - */ - type?: string | null; - } - /** - * Directory Site Contact Assignment - */ - export interface Schema$DirectorySiteContactAssignment { - /** - * ID of this directory site contact. This is a read-only, auto-generated field. - */ - contactId?: string | null; - /** - * Visibility of this directory site contact assignment. When set to PUBLIC this contact assignment is visible to all account and agency users; when set to PRIVATE it is visible only to the site. - */ - visibility?: string | null; - } - /** - * Directory Site Contact List Response - */ - export interface Schema$DirectorySiteContactsListResponse { - /** - * Directory site contact collection - */ - directorySiteContacts?: Schema$DirectorySiteContact[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Directory Site Settings - */ - export interface Schema$DirectorySiteSettings { - /** - * Whether this directory site has disabled active view creatives. - */ - activeViewOptOut?: boolean | null; - /** - * Directory site Ad Manager settings. - */ - dfpSettings?: Schema$DfpSettings; - /** - * Whether this site accepts in-stream video ads. - */ - instreamVideoPlacementAccepted?: boolean | null; - /** - * Whether this site accepts interstitial ads. - */ - interstitialPlacementAccepted?: boolean | null; - /** - * Whether this directory site has disabled Nielsen OCR reach ratings. - */ - nielsenOcrOptOut?: boolean | null; - /** - * Whether this directory site has disabled generation of Verification ins tags. - */ - verificationTagOptOut?: boolean | null; - /** - * Whether this directory site has disabled active view for in-stream video creatives. This is a read-only field. - */ - videoActiveViewOptOut?: boolean | null; - } - /** - * Directory Site List Response - */ - export interface Schema$DirectorySitesListResponse { - /** - * Directory site collection. - */ - directorySites?: Schema$DirectorySite[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds. - */ - export interface Schema$DynamicTargetingKey { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". - */ - kind?: string | null; - /** - * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. - */ - name?: string | null; - /** - * ID of the object of this dynamic targeting key. This is a required field. - */ - objectId?: string | null; - /** - * Type of the object of this dynamic targeting key. This is a required field. - */ - objectType?: string | null; - } - /** - * Dynamic Targeting Key List Response - */ - export interface Schema$DynamicTargetingKeysListResponse { - /** - * Dynamic targeting key collection. - */ - dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse". - */ - kind?: string | null; - } - /** - * A description of how user IDs are encrypted. - */ - export interface Schema$EncryptionInfo { - /** - * The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. - */ - encryptionEntityId?: string | null; - /** - * The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. - */ - encryptionEntityType?: string | null; - /** - * Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. - */ - encryptionSource?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". - */ - kind?: string | null; - } - /** - * Contains properties of an event tag. - */ - export interface Schema$EventTag { - /** - * Account ID of this event tag. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this event tag. This field or the campaignId field is required on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Campaign ID of this event tag. This field or the advertiserId field is required on insertion. - */ - campaignId?: string | null; - /** - * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. - */ - enabledByDefault?: boolean | null; - /** - * Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. - */ - excludeFromAdxRequests?: boolean | null; - /** - * ID of this event tag. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag". - */ - kind?: string | null; - /** - * Name of this event tag. This is a required field and must be less than 256 characters long. - */ - name?: string | null; - /** - * Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. - */ - siteFilterType?: string | null; - /** - * Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter. - */ - siteIds?: string[] | null; - /** - * Whether this tag is SSL-compliant or not. This is a read-only field. - */ - sslCompliant?: boolean | null; - /** - * Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. - */ - status?: string | null; - /** - * Subaccount ID of this event tag. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. - */ - type?: string | null; - /** - * Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. - */ - url?: string | null; - /** - * Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. - */ - urlEscapeLevels?: number | null; - } - /** - * Event tag override information. - */ - export interface Schema$EventTagOverride { - /** - * Whether this override is enabled. - */ - enabled?: boolean | null; - /** - * ID of this event tag override. This is a read-only, auto-generated field. - */ - id?: string | null; - } - /** - * Event Tag List Response - */ - export interface Schema$EventTagsListResponse { - /** - * Event tag collection. - */ - eventTags?: Schema$EventTag[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse". - */ - kind?: string | null; - } - /** - * Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE". - */ - export interface Schema$File { - /** - * The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. - */ - dateRange?: Schema$DateRange; - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The filename of the file. - */ - fileName?: string | null; - /** - * The output format of the report. Only available once the file is available. - */ - format?: string | null; - /** - * The unique ID of this report file. - */ - id?: string | null; - /** - * The kind of resource this is, in this case dfareporting#file. - */ - kind?: string | null; - /** - * The timestamp in milliseconds since epoch when this file was last modified. - */ - lastModifiedTime?: string | null; - /** - * The ID of the report this file was generated from. - */ - reportId?: string | null; - /** - * The status of the report file. - */ - status?: string | null; - /** - * The URLs where the completed report file can be downloaded. - */ - urls?: {apiUrl?: string; browserUrl?: string} | null; - } - /** - * Represents the list of File resources. - */ - export interface Schema$FileList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The files returned in this response. - */ - items?: Schema$File[]; - /** - * The kind of list this is, in this case dfareporting#fileList. - */ - kind?: string | null; - /** - * Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. - */ - nextPageToken?: string | null; - } - /** - * Flight - */ - export interface Schema$Flight { - /** - * Inventory item flight end date. - */ - endDate?: string | null; - /** - * Rate or cost of this flight. - */ - rateOrCost?: string | null; - /** - * Inventory item flight start date. - */ - startDate?: string | null; - /** - * Units of this flight. - */ - units?: string | null; - } - /** - * Floodlight Activity GenerateTag Response - */ - export interface Schema$FloodlightActivitiesGenerateTagResponse { - /** - * Generated tag for this Floodlight activity. For global site tags, this is the event snippet. - */ - floodlightActivityTag?: string | null; - /** - * The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. - */ - globalSiteTagGlobalSnippet?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". - */ - kind?: string | null; - } - /** - * Floodlight Activity List Response - */ - export interface Schema$FloodlightActivitiesListResponse { - /** - * Floodlight activity collection. - */ - floodlightActivities?: Schema$FloodlightActivity[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains properties of a Floodlight activity. - */ - export interface Schema$FloodlightActivity { - /** - * Account ID of this floodlight activity. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. - */ - cacheBustingType?: string | null; - /** - * Counting method for conversions for this floodlight activity. This is a required field. - */ - countingMethod?: string | null; - /** - * Dynamic floodlight tags. - */ - defaultTags?: Schema$FloodlightActivityDynamicTag[]; - /** - * URL where this tag will be deployed. If specified, must be less than 256 characters long. - */ - expectedUrl?: string | null; - /** - * Floodlight activity group ID of this floodlight activity. This is a required field. - */ - floodlightActivityGroupId?: string | null; - /** - * Name of the associated floodlight activity group. This is a read-only field. - */ - floodlightActivityGroupName?: string | null; - /** - * Tag string of the associated floodlight activity group. This is a read-only field. - */ - floodlightActivityGroupTagString?: string | null; - /** - * Type of the associated floodlight activity group. This is a read-only field. - */ - floodlightActivityGroupType?: string | null; - /** - * Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. - */ - floodlightConfigurationId?: string | null; - /** - * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * The type of Floodlight tag this activity will generate. This is a required field. - */ - floodlightTagType?: string | null; - /** - * Whether this activity is archived. - */ - hidden?: boolean | null; - /** - * ID of this floodlight activity. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". - */ - kind?: string | null; - /** - * Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. - */ - name?: string | null; - /** - * General notes or implementation instructions for the tag. - */ - notes?: string | null; - /** - * Publisher dynamic floodlight tags. - */ - publisherTags?: Schema$FloodlightActivityPublisherDynamicTag[]; - /** - * Whether this tag should use SSL. - */ - secure?: boolean | null; - /** - * Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. - */ - sslCompliant?: boolean | null; - /** - * Whether this floodlight activity must be SSL-compliant. - */ - sslRequired?: boolean | null; - /** - * Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. - */ - tagFormat?: string | null; - /** - * Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. - */ - tagString?: string | null; - /** - * List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. - */ - userDefinedVariableTypes?: string[] | null; - } - /** - * Dynamic Tag - */ - export interface Schema$FloodlightActivityDynamicTag { - /** - * ID of this dynamic tag. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Name of this tag. - */ - name?: string | null; - /** - * Tag code. - */ - tag?: string | null; - } - /** - * Contains properties of a Floodlight activity group. - */ - export interface Schema$FloodlightActivityGroup { - /** - * Account ID of this floodlight activity group. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Floodlight configuration ID of this floodlight activity group. This is a required field. - */ - floodlightConfigurationId?: string | null; - /** - * Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. - */ - floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this floodlight activity group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". - */ - kind?: string | null; - /** - * Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. - */ - name?: string | null; - /** - * Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. - */ - tagString?: string | null; - /** - * Type of the floodlight activity group. This is a required field that is read-only after insertion. - */ - type?: string | null; - } - /** - * Floodlight Activity Group List Response - */ - export interface Schema$FloodlightActivityGroupsListResponse { - /** - * Floodlight activity group collection. - */ - floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Publisher Dynamic Tag - */ - export interface Schema$FloodlightActivityPublisherDynamicTag { - /** - * Whether this tag is applicable only for click-throughs. - */ - clickThrough?: boolean | null; - /** - * Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. - */ - directorySiteId?: string | null; - /** - * Dynamic floodlight tag. - */ - dynamicTag?: Schema$FloodlightActivityDynamicTag; - /** - * Site ID of this dynamic tag. - */ - siteId?: string | null; - /** - * Dimension value for the ID of the site. This is a read-only, auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this tag is applicable only for view-throughs. - */ - viewThrough?: boolean | null; - } - /** - * Contains properties of a Floodlight configuration. - */ - export interface Schema$FloodlightConfiguration { - /** - * Account ID of this floodlight configuration. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of the parent advertiser of this floodlight configuration. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether advertiser data is shared with Google Analytics. - */ - analyticsDataSharingEnabled?: boolean | null; - /** - * Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. - */ - exposureToConversionEnabled?: boolean | null; - /** - * Day that will be counted as the first day of the week in reports. This is a required field. - */ - firstDayOfWeek?: string | null; - /** - * ID of this floodlight configuration. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Whether in-app attribution tracking is enabled. - */ - inAppAttributionTrackingEnabled?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration". - */ - kind?: string | null; - /** - * Lookback window settings for this floodlight configuration. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Types of attribution options for natural search conversions. - */ - naturalSearchConversionAttributionOption?: string | null; - /** - * Settings for Campaign Manager Omniture integration. - */ - omnitureSettings?: Schema$OmnitureSettings; - /** - * Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - /** - * Configuration settings for dynamic and image floodlight tags. - */ - tagSettings?: Schema$TagSettings; - /** - * List of third-party authentication tokens enabled for this configuration. - */ - thirdPartyAuthenticationTokens?: Schema$ThirdPartyAuthenticationToken[]; - /** - * List of user defined variables enabled for this configuration. - */ - userDefinedVariableConfigurations?: Schema$UserDefinedVariableConfiguration[]; - } - /** - * Floodlight Configuration List Response - */ - export interface Schema$FloodlightConfigurationsListResponse { - /** - * Floodlight configuration collection. - */ - floodlightConfigurations?: Schema$FloodlightConfiguration[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse". - */ - kind?: string | null; - } - /** - * Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". - */ - export interface Schema$FloodlightReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - } - /** - * Frequency Cap. - */ - export interface Schema$FrequencyCap { - /** - * Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive. - */ - duration?: string | null; - /** - * Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive. - */ - impressions?: string | null; - } - /** - * FsCommand. - */ - export interface Schema$FsCommand { - /** - * Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. - */ - left?: number | null; - /** - * Position in the browser where the window will open. - */ - positionOption?: string | null; - /** - * Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. - */ - top?: number | null; - /** - * Height of the window. - */ - windowHeight?: number | null; - /** - * Width of the window. - */ - windowWidth?: number | null; - } - /** - * Geographical Targeting. - */ - export interface Schema$GeoTargeting { - /** - * Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. - */ - cities?: Schema$City[]; - /** - * Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. - */ - countries?: Schema$Country[]; - /** - * Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. - */ - excludeCountries?: boolean | null; - /** - * Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. - */ - metros?: Schema$Metro[]; - /** - * Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. - */ - postalCodes?: Schema$PostalCode[]; - /** - * Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. - */ - regions?: Schema$Region[]; - } - /** - * Represents a buy from the Planning inventory store. - */ - export interface Schema$InventoryItem { - /** - * Account ID of this inventory item. - */ - accountId?: string | null; - /** - * Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group. - */ - adSlots?: Schema$AdSlot[]; - /** - * Advertiser ID of this inventory item. - */ - advertiserId?: string | null; - /** - * Content category ID of this inventory item. - */ - contentCategoryId?: string | null; - /** - * Estimated click-through rate of this inventory item. - */ - estimatedClickThroughRate?: string | null; - /** - * Estimated conversion rate of this inventory item. - */ - estimatedConversionRate?: string | null; - /** - * ID of this inventory item. - */ - id?: string | null; - /** - * Whether this inventory item is in plan. - */ - inPlan?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". - */ - kind?: string | null; - /** - * Information about the most recent modification of this inventory item. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots. - */ - name?: string | null; - /** - * Negotiation channel ID of this inventory item. - */ - negotiationChannelId?: string | null; - /** - * Order ID of this inventory item. - */ - orderId?: string | null; - /** - * Placement strategy ID of this inventory item. - */ - placementStrategyId?: string | null; - /** - * Pricing of this inventory item. - */ - pricing?: Schema$Pricing; - /** - * Project ID of this inventory item. - */ - projectId?: string | null; - /** - * RFP ID of this inventory item. - */ - rfpId?: string | null; - /** - * ID of the site this inventory item is associated with. - */ - siteId?: string | null; - /** - * Subaccount ID of this inventory item. - */ - subaccountId?: string | null; - /** - * Type of inventory item. - */ - type?: string | null; - } - /** - * Inventory item List Response - */ - export interface Schema$InventoryItemsListResponse { - /** - * Inventory item collection - */ - inventoryItems?: Schema$InventoryItem[]; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Key Value Targeting Expression. - */ - export interface Schema$KeyValueTargetingExpression { - /** - * Keyword expression being targeted by the ad. - */ - expression?: string | null; - } - /** - * Contains information about where a user's browser is taken after the user clicks an ad. - */ - export interface Schema$LandingPage { - /** - * Advertiser ID of this landing page. This is a required field. - */ - advertiserId?: string | null; - /** - * Whether this landing page has been archived. - */ - archived?: boolean | null; - /** - * Links that will direct the user to a mobile app, if installed. - */ - deepLinks?: Schema$DeepLink[]; - /** - * ID of this landing page. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage". - */ - kind?: string | null; - /** - * Name of this landing page. This is a required field. It must be less than 256 characters long. - */ - name?: string | null; - /** - * URL of this landing page. This is a required field. - */ - url?: string | null; - } - /** - * Contains information about a language that can be targeted by ads. - */ - export interface Schema$Language { - /** - * Language ID of this language. This is the ID used for targeting and generating reports. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#language". - */ - kind?: string | null; - /** - * Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese. - */ - languageCode?: string | null; - /** - * Name of this language. - */ - name?: string | null; - } - /** - * Language List Response - */ - export interface Schema$LanguagesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse". - */ - kind?: string | null; - /** - * Language collection. - */ - languages?: Schema$Language[]; - } - /** - * Language Targeting. - */ - export interface Schema$LanguageTargeting { - /** - * Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated. - */ - languages?: Schema$Language[]; - } - /** - * Modification timestamp. - */ - export interface Schema$LastModifiedInfo { - /** - * Timestamp of the last change in milliseconds since epoch. - */ - time?: string | null; - } - /** - * A group clause made up of list population terms representing constraints joined by ORs. - */ - export interface Schema$ListPopulationClause { - /** - * Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs. - */ - terms?: Schema$ListPopulationTerm[]; - } - /** - * Remarketing List Population Rule. - */ - export interface Schema$ListPopulationRule { - /** - * Floodlight activity ID associated with this rule. This field can be left blank. - */ - floodlightActivityId?: string | null; - /** - * Name of floodlight activity associated with this rule. This is a read-only, auto-generated field. - */ - floodlightActivityName?: string | null; - /** - * Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs. - */ - listPopulationClauses?: Schema$ListPopulationClause[]; - } - /** - * Remarketing List Population Rule Term. - */ - export interface Schema$ListPopulationTerm { - /** - * Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. - */ - contains?: boolean | null; - /** - * Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - negation?: boolean | null; - /** - * Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - operator?: string | null; - /** - * ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. - */ - remarketingListId?: string | null; - /** - * List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. - */ - type?: string | null; - /** - * Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - value?: string | null; - /** - * Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. - */ - variableFriendlyName?: string | null; - /** - * Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. - */ - variableName?: string | null; - } - /** - * Remarketing List Targeting Expression. - */ - export interface Schema$ListTargetingExpression { - /** - * Expression describing which lists are being targeted by the ad. - */ - expression?: string | null; - } - /** - * Lookback configuration settings. - */ - export interface Schema$LookbackConfiguration { - /** - * Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. - */ - clickDuration?: number | null; - /** - * Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. - */ - postImpressionActivitiesDuration?: number | null; - } - /** - * Represents a metric. - */ - export interface Schema$Metric { - /** - * The kind of resource this is, in this case dfareporting#metric. - */ - kind?: string | null; - /** - * The metric name, e.g. dfa:impressions - */ - name?: string | null; - } - /** - * Contains information about a metro region that can be targeted by ads. - */ - export interface Schema$Metro { - /** - * Country code of the country to which this metro region belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this metro region belongs. - */ - countryDartId?: string | null; - /** - * DART ID of this metro region. - */ - dartId?: string | null; - /** - * DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code. - */ - dmaId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro". - */ - kind?: string | null; - /** - * Metro code of this metro region. This is equivalent to dma_id. - */ - metroCode?: string | null; - /** - * Name of this metro region. - */ - name?: string | null; - } - /** - * Metro List Response - */ - export interface Schema$MetrosListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse". - */ - kind?: string | null; - /** - * Metro collection. - */ - metros?: Schema$Metro[]; - } - /** - * Contains information about a mobile app. Used as a landing page deep link. - */ - export interface Schema$MobileApp { - /** - * Mobile app directory. - */ - directory?: string | null; - /** - * ID of this mobile app. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp". - */ - kind?: string | null; - /** - * Publisher name. - */ - publisherName?: string | null; - /** - * Title of this mobile app. - */ - title?: string | null; - } - /** - * Mobile app List Response - */ - export interface Schema$MobileAppsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse". - */ - kind?: string | null; - /** - * Mobile apps collection. - */ - mobileApps?: Schema$MobileApp[]; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - } - /** - * Contains information about a mobile carrier that can be targeted by ads. - */ - export interface Schema$MobileCarrier { - /** - * Country code of the country to which this mobile carrier belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this mobile carrier belongs. - */ - countryDartId?: string | null; - /** - * ID of this mobile carrier. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier". - */ - kind?: string | null; - /** - * Name of this mobile carrier. - */ - name?: string | null; - } - /** - * Mobile Carrier List Response - */ - export interface Schema$MobileCarriersListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse". - */ - kind?: string | null; - /** - * Mobile carrier collection. - */ - mobileCarriers?: Schema$MobileCarrier[]; - } - /** - * Object Filter. - */ - export interface Schema$ObjectFilter { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter". - */ - kind?: string | null; - /** - * Applicable when status is ASSIGNED. The user has access to objects with these object IDs. - */ - objectIds?: string[] | null; - /** - * Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list. - */ - status?: string | null; - } - /** - * Offset Position. - */ - export interface Schema$OffsetPosition { - /** - * Offset distance from left side of an asset or a window. - */ - left?: number | null; - /** - * Offset distance from top side of an asset or a window. - */ - top?: number | null; - } - /** - * Omniture Integration Settings. - */ - export interface Schema$OmnitureSettings { - /** - * Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true. - */ - omnitureCostDataEnabled?: boolean | null; - /** - * Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled. - */ - omnitureIntegrationEnabled?: boolean | null; - } - /** - * Contains information about an operating system that can be targeted by ads. - */ - export interface Schema$OperatingSystem { - /** - * DART ID of this operating system. This is the ID used for targeting. - */ - dartId?: string | null; - /** - * Whether this operating system is for desktop. - */ - desktop?: boolean | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem". - */ - kind?: string | null; - /** - * Whether this operating system is for mobile. - */ - mobile?: boolean | null; - /** - * Name of this operating system. - */ - name?: string | null; - } - /** - * Operating System List Response - */ - export interface Schema$OperatingSystemsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse". - */ - kind?: string | null; - /** - * Operating system collection. - */ - operatingSystems?: Schema$OperatingSystem[]; - } - /** - * Contains information about a particular version of an operating system that can be targeted by ads. - */ - export interface Schema$OperatingSystemVersion { - /** - * ID of this operating system version. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion". - */ - kind?: string | null; - /** - * Major version (leftmost number) of this operating system version. - */ - majorVersion?: string | null; - /** - * Minor version (number after the first dot) of this operating system version. - */ - minorVersion?: string | null; - /** - * Name of this operating system version. - */ - name?: string | null; - /** - * Operating system of this operating system version. - */ - operatingSystem?: Schema$OperatingSystem; - } - /** - * Operating System Version List Response - */ - export interface Schema$OperatingSystemVersionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse". - */ - kind?: string | null; - /** - * Operating system version collection. - */ - operatingSystemVersions?: Schema$OperatingSystemVersion[]; - } - /** - * Creative optimization activity. - */ - export interface Schema$OptimizationActivity { - /** - * Floodlight activity ID of this optimization activity. This is a required field. - */ - floodlightActivityId?: string | null; - /** - * Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. - */ - floodlightActivityIdDimensionValue?: Schema$DimensionValue; - /** - * Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. - */ - weight?: number | null; - } - /** - * Describes properties of a Planning order. - */ - export interface Schema$Order { - /** - * Account ID of this order. - */ - accountId?: string | null; - /** - * Advertiser ID of this order. - */ - advertiserId?: string | null; - /** - * IDs for users that have to approve documents created for this order. - */ - approverUserProfileIds?: string[] | null; - /** - * Buyer invoice ID associated with this order. - */ - buyerInvoiceId?: string | null; - /** - * Name of the buyer organization. - */ - buyerOrganizationName?: string | null; - /** - * Comments in this order. - */ - comments?: string | null; - /** - * Contacts for this order. - */ - contacts?: Schema$OrderContact[]; - /** - * ID of this order. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#order". - */ - kind?: string | null; - /** - * Information about the most recent modification of this order. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this order. - */ - name?: string | null; - /** - * Notes of this order. - */ - notes?: string | null; - /** - * ID of the terms and conditions template used in this order. - */ - planningTermId?: string | null; - /** - * Project ID of this order. - */ - projectId?: string | null; - /** - * Seller order ID associated with this order. - */ - sellerOrderId?: string | null; - /** - * Name of the seller organization. - */ - sellerOrganizationName?: string | null; - /** - * Site IDs this order is associated with. - */ - siteId?: string[] | null; - /** - * Free-form site names this order is associated with. - */ - siteNames?: string[] | null; - /** - * Subaccount ID of this order. - */ - subaccountId?: string | null; - /** - * Terms and conditions of this order. - */ - termsAndConditions?: string | null; - } - /** - * Contact of an order. - */ - export interface Schema$OrderContact { - /** - * Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID. - */ - contactInfo?: string | null; - /** - * Name of this contact. - */ - contactName?: string | null; - /** - * Title of this contact. - */ - contactTitle?: string | null; - /** - * Type of this contact. - */ - contactType?: string | null; - /** - * ID of the user profile containing the signature that will be embedded into order documents. - */ - signatureUserProfileId?: string | null; - } - /** - * Contains properties of a Planning order document. - */ - export interface Schema$OrderDocument { - /** - * Account ID of this order document. - */ - accountId?: string | null; - /** - * Advertiser ID of this order document. - */ - advertiserId?: string | null; - /** - * The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. - */ - amendedOrderDocumentId?: string | null; - /** - * IDs of users who have approved this order document. - */ - approvedByUserProfileIds?: string[] | null; - /** - * Whether this order document is cancelled. - */ - cancelled?: boolean | null; - /** - * Information about the creation of this order document. - */ - createdInfo?: Schema$LastModifiedInfo; - /** - * Effective date of this order document. - */ - effectiveDate?: string | null; - /** - * ID of this order document. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument". - */ - kind?: string | null; - /** - * List of email addresses that received the last sent document. - */ - lastSentRecipients?: string[] | null; - /** - * Timestamp of the last email sent with this order document. - */ - lastSentTime?: string | null; - /** - * ID of the order from which this order document is created. - */ - orderId?: string | null; - /** - * Project ID of this order document. - */ - projectId?: string | null; - /** - * Whether this order document has been signed. - */ - signed?: boolean | null; - /** - * Subaccount ID of this order document. - */ - subaccountId?: string | null; - /** - * Title of this order document. - */ - title?: string | null; - /** - * Type of this order document - */ - type?: string | null; - } - /** - * Order document List Response - */ - export interface Schema$OrderDocumentsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Order document collection - */ - orderDocuments?: Schema$OrderDocument[]; - } - /** - * Order List Response - */ - export interface Schema$OrdersListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Order collection. - */ - orders?: Schema$Order[]; - } - /** - * Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". - */ - export interface Schema$PathToConversionReportCompatibleFields { - /** - * Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. - */ - conversionDimensions?: Schema$Dimension[]; - /** - * Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report. - */ - customFloodlightVariables?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report. - */ - perInteractionDimensions?: Schema$Dimension[]; - } - /** - * Contains properties of a placement. - */ - export interface Schema$Placement { - /** - * Account ID of this placement. This field can be left blank. - */ - accountId?: string | null; - /** - * Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. - */ - adBlockingOptOut?: boolean | null; - /** - * Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. - */ - additionalSizes?: Schema$Size[]; - /** - * Advertiser ID of this placement. This field can be left blank. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this placement is archived. - */ - archived?: boolean | null; - /** - * Campaign ID of this placement. This field is a required field on insertion. - */ - campaignId?: string | null; - /** - * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * Comments for this placement. - */ - comment?: string | null; - /** - * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. - */ - compatibility?: string | null; - /** - * ID of the content category assigned to this placement. - */ - contentCategoryId?: string | null; - /** - * Information about the creation of this placement. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. - */ - directorySiteId?: string | null; - /** - * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * External ID for this placement. - */ - externalId?: string | null; - /** - * ID of this placement. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this placement. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key name of this placement. This is a read-only, auto-generated field. - */ - keyName?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". - */ - kind?: string | null; - /** - * Information about the most recent modification of this placement. This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Lookback window settings for this placement. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Name of this placement.This is a required field and must be less than 256 characters long. - */ - name?: string | null; - /** - * Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. - */ - paymentApproved?: boolean | null; - /** - * Payment source for this placement. This is a required field that is read-only after insertion. - */ - paymentSource?: string | null; - /** - * ID of this placement's group, if applicable. - */ - placementGroupId?: string | null; - /** - * Dimension value for the ID of the placement group. This is a read-only, auto-generated field. - */ - placementGroupIdDimensionValue?: Schema$DimensionValue; - /** - * ID of the placement strategy assigned to this placement. - */ - placementStrategyId?: string | null; - /** - * Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. - */ - pricingSchedule?: Schema$PricingSchedule; - /** - * Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. - */ - primary?: boolean | null; - /** - * Information about the last publisher update. This is a read-only field. - */ - publisherUpdateInfo?: Schema$LastModifiedInfo; - /** - * Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. - */ - siteId?: string | null; - /** - * Dimension value for the ID of the site. This is a read-only, auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion. - */ - size?: Schema$Size; - /** - * Whether creatives assigned to this placement must be SSL-compliant. - */ - sslRequired?: boolean | null; - /** - * Third-party placement status. - */ - status?: string | null; - /** - * Subaccount ID of this placement. This field can be left blank. - */ - subaccountId?: string | null; - /** - * Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" - */ - tagFormats?: string[] | null; - /** - * Tag settings for this placement. - */ - tagSetting?: Schema$TagSetting; - /** - * Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. - */ - videoActiveViewOptOut?: boolean | null; - /** - * A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. - */ - videoSettings?: Schema$VideoSettings; - /** - * VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. - */ - vpaidAdapterChoice?: string | null; - } - /** - * Placement Assignment. - */ - export interface Schema$PlacementAssignment { - /** - * Whether this placement assignment is active. When true, the placement will be included in the ad's rotation. - */ - active?: boolean | null; - /** - * ID of the placement to be assigned. This is a required field. - */ - placementId?: string | null; - /** - * Dimension value for the ID of the placement. This is a read-only, auto-generated field. - */ - placementIdDimensionValue?: Schema$DimensionValue; - /** - * Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated. - */ - sslRequired?: boolean | null; - } - /** - * Contains properties of a package or roadblock. - */ - export interface Schema$PlacementGroup { - /** - * Account ID of this placement group. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Advertiser ID of this placement group. This is a required field on insertion. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Whether this placement group is archived. - */ - archived?: boolean | null; - /** - * Campaign ID of this placement group. This field is required on insertion. - */ - campaignId?: string | null; - /** - * Dimension value for the ID of the campaign. This is a read-only, auto-generated field. - */ - campaignIdDimensionValue?: Schema$DimensionValue; - /** - * IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. - */ - childPlacementIds?: string[] | null; - /** - * Comments for this placement group. - */ - comment?: string | null; - /** - * ID of the content category assigned to this placement group. - */ - contentCategoryId?: string | null; - /** - * Information about the creation of this placement group. This is a read-only field. - */ - createInfo?: Schema$LastModifiedInfo; - /** - * Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. - */ - directorySiteId?: string | null; - /** - * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * External ID for this placement. - */ - externalId?: string | null; - /** - * ID of this placement group. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this placement group. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". - */ - kind?: string | null; - /** - * Information about the most recent modification of this placement group. This is a read-only field. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this placement group. This is a required field and must be less than 256 characters long. - */ - name?: string | null; - /** - * Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. - */ - placementGroupType?: string | null; - /** - * ID of the placement strategy assigned to this placement group. - */ - placementStrategyId?: string | null; - /** - * Pricing schedule of this placement group. This field is required on insertion. - */ - pricingSchedule?: Schema$PricingSchedule; - /** - * ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. - */ - primaryPlacementId?: string | null; - /** - * Dimension value for the ID of the primary placement. This is a read-only, auto-generated field. - */ - primaryPlacementIdDimensionValue?: Schema$DimensionValue; - /** - * Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. - */ - siteId?: string | null; - /** - * Dimension value for the ID of the site. This is a read-only, auto-generated field. - */ - siteIdDimensionValue?: Schema$DimensionValue; - /** - * Subaccount ID of this placement group. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Placement Group List Response - */ - export interface Schema$PlacementGroupsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Placement group collection. - */ - placementGroups?: Schema$PlacementGroup[]; - } - /** - * Placement GenerateTags Response - */ - export interface Schema$PlacementsGenerateTagsResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". - */ - kind?: string | null; - /** - * Set of generated tags for the specified placements. - */ - placementTags?: Schema$PlacementTag[]; - } - /** - * Placement List Response - */ - export interface Schema$PlacementsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Placement collection. - */ - placements?: Schema$Placement[]; - } - /** - * Placement Strategy List Response - */ - export interface Schema$PlacementStrategiesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Placement strategy collection. - */ - placementStrategies?: Schema$PlacementStrategy[]; - } - /** - * Contains properties of a placement strategy. - */ - export interface Schema$PlacementStrategy { - /** - * Account ID of this placement strategy.This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * ID of this placement strategy. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy". - */ - kind?: string | null; - /** - * Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account. - */ - name?: string | null; - } - /** - * Placement Tag - */ - export interface Schema$PlacementTag { - /** - * Placement ID - */ - placementId?: string | null; - /** - * Tags generated for this placement. - */ - tagDatas?: Schema$TagData[]; - } - /** - * Contains information about a platform type that can be targeted by ads. - */ - export interface Schema$PlatformType { - /** - * ID of this platform type. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType". - */ - kind?: string | null; - /** - * Name of this platform type. - */ - name?: string | null; - } - /** - * Platform Type List Response - */ - export interface Schema$PlatformTypesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse". - */ - kind?: string | null; - /** - * Platform type collection. - */ - platformTypes?: Schema$PlatformType[]; - } - /** - * Popup Window Properties. - */ - export interface Schema$PopupWindowProperties { - /** - * Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID - */ - dimension?: Schema$Size; - /** - * Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES. - */ - offset?: Schema$OffsetPosition; - /** - * Popup window position either centered or at specific coordinate. - */ - positionType?: string | null; - /** - * Whether to display the browser address bar. - */ - showAddressBar?: boolean | null; - /** - * Whether to display the browser menu bar. - */ - showMenuBar?: boolean | null; - /** - * Whether to display the browser scroll bar. - */ - showScrollBar?: boolean | null; - /** - * Whether to display the browser status bar. - */ - showStatusBar?: boolean | null; - /** - * Whether to display the browser tool bar. - */ - showToolBar?: boolean | null; - /** - * Title of popup window. - */ - title?: string | null; - } - /** - * Contains information about a postal code that can be targeted by ads. - */ - export interface Schema$PostalCode { - /** - * Postal code. This is equivalent to the id field. - */ - code?: string | null; - /** - * Country code of the country to which this postal code belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this postal code belongs. - */ - countryDartId?: string | null; - /** - * ID of this postal code. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode". - */ - kind?: string | null; - } - /** - * Postal Code List Response - */ - export interface Schema$PostalCodesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse". - */ - kind?: string | null; - /** - * Postal code collection. - */ - postalCodes?: Schema$PostalCode[]; - } - /** - * Pricing Information - */ - export interface Schema$Pricing { - /** - * Cap cost type of this inventory item. - */ - capCostType?: string | null; - /** - * End date of this inventory item. - */ - endDate?: string | null; - /** - * Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. - */ - flights?: Schema$Flight[]; - /** - * Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary. - */ - groupType?: string | null; - /** - * Pricing type of this inventory item. - */ - pricingType?: string | null; - /** - * Start date of this inventory item. - */ - startDate?: string | null; - } - /** - * Pricing Schedule - */ - export interface Schema$PricingSchedule { - /** - * Placement cap cost option. - */ - capCostOption?: string | null; - /** - * Whether cap costs are ignored by ad serving. - */ - disregardOverdelivery?: boolean | null; - /** - * Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion. - */ - endDate?: string | null; - /** - * Whether this placement is flighted. If true, pricing periods will be computed automatically. - */ - flighted?: boolean | null; - /** - * Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. - */ - floodlightActivityId?: string | null; - /** - * Pricing periods for this placement. - */ - pricingPeriods?: Schema$PricingSchedulePricingPeriod[]; - /** - * Placement pricing type. This field is required on insertion. - */ - pricingType?: string | null; - /** - * Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion. - */ - startDate?: string | null; - /** - * Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. - */ - testingStartDate?: string | null; - } - /** - * Pricing Period - */ - export interface Schema$PricingSchedulePricingPeriod { - /** - * Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. - */ - endDate?: string | null; - /** - * Comments for this pricing period. - */ - pricingComment?: string | null; - /** - * Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. - */ - rateOrCostNanos?: string | null; - /** - * Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. - */ - startDate?: string | null; - /** - * Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. - */ - units?: string | null; - } - /** - * Contains properties of a Planning project. - */ - export interface Schema$Project { - /** - * Account ID of this project. - */ - accountId?: string | null; - /** - * Advertiser ID of this project. - */ - advertiserId?: string | null; - /** - * Audience age group of this project. - */ - audienceAgeGroup?: string | null; - /** - * Audience gender of this project. - */ - audienceGender?: string | null; - /** - * Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar. - */ - budget?: string | null; - /** - * Client billing code of this project. - */ - clientBillingCode?: string | null; - /** - * Name of the project client. - */ - clientName?: string | null; - /** - * End date of the project. - */ - endDate?: string | null; - /** - * ID of this project. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". - */ - kind?: string | null; - /** - * Information about the most recent modification of this project. - */ - lastModifiedInfo?: Schema$LastModifiedInfo; - /** - * Name of this project. - */ - name?: string | null; - /** - * Overview of this project. - */ - overview?: string | null; - /** - * Start date of the project. - */ - startDate?: string | null; - /** - * Subaccount ID of this project. - */ - subaccountId?: string | null; - /** - * Number of clicks that the advertiser is targeting. - */ - targetClicks?: string | null; - /** - * Number of conversions that the advertiser is targeting. - */ - targetConversions?: string | null; - /** - * CPA that the advertiser is targeting. - */ - targetCpaNanos?: string | null; - /** - * CPC that the advertiser is targeting. - */ - targetCpcNanos?: string | null; - /** - * vCPM from Active View that the advertiser is targeting. - */ - targetCpmActiveViewNanos?: string | null; - /** - * CPM that the advertiser is targeting. - */ - targetCpmNanos?: string | null; - /** - * Number of impressions that the advertiser is targeting. - */ - targetImpressions?: string | null; - } - /** - * Project List Response - */ - export interface Schema$ProjectsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Project collection. - */ - projects?: Schema$Project[]; - } - /** - * Represents fields that are compatible to be selected for a report of type "REACH". - */ - export interface Schema$ReachReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#reachReportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. - */ - pivotedActivityMetrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report. - */ - reachByFrequencyMetrics?: Schema$Metric[]; - } - /** - * Represents a recipient. - */ - export interface Schema$Recipient { - /** - * The delivery type for the recipient. - */ - deliveryType?: string | null; - /** - * The email address of the recipient. - */ - email?: string | null; - /** - * The kind of resource this is, in this case dfareporting#recipient. - */ - kind?: string | null; - } - /** - * Contains information about a region that can be targeted by ads. - */ - export interface Schema$Region { - /** - * Country code of the country to which this region belongs. - */ - countryCode?: string | null; - /** - * DART ID of the country to which this region belongs. - */ - countryDartId?: string | null; - /** - * DART ID of this region. - */ - dartId?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#region". - */ - kind?: string | null; - /** - * Name of this region. - */ - name?: string | null; - /** - * Region code. - */ - regionCode?: string | null; - } - /** - * Region List Response - */ - export interface Schema$RegionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse". - */ - kind?: string | null; - /** - * Region collection. - */ - regions?: Schema$Region[]; - } - /** - * Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource. - */ - export interface Schema$RemarketingList { - /** - * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. - */ - accountId?: string | null; - /** - * Whether this remarketing list is active. - */ - active?: boolean | null; - /** - * Dimension value for the advertiser ID that owns this remarketing list. This is a required field. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Remarketing list description. - */ - description?: string | null; - /** - * Remarketing list ID. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList". - */ - kind?: string | null; - /** - * Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. - */ - lifeSpan?: string | null; - /** - * Rule used to populate the remarketing list with users. - */ - listPopulationRule?: Schema$ListPopulationRule; - /** - * Number of users currently in the list. This is a read-only field. - */ - listSize?: string | null; - /** - * Product from which this remarketing list was originated. - */ - listSource?: string | null; - /** - * Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. - */ - name?: string | null; - /** - * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. - */ - subaccountId?: string | null; - } - /** - * Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers. - */ - export interface Schema$RemarketingListShare { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare". - */ - kind?: string | null; - /** - * Remarketing list ID. This is a read-only, auto-generated field. - */ - remarketingListId?: string | null; - /** - * Accounts that the remarketing list is shared with. - */ - sharedAccountIds?: string[] | null; - /** - * Advertisers that the remarketing list is shared with. - */ - sharedAdvertiserIds?: string[] | null; - } - /** - * Remarketing list response - */ - export interface Schema$RemarketingListsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Remarketing list collection. - */ - remarketingLists?: Schema$RemarketingList[]; - } - /** - * Represents a Report resource. - */ - export interface Schema$Report { - /** - * The account ID to which this report belongs. - */ - accountId?: string | null; - /** - * The report criteria for a report of type "STANDARD". - */ - criteria?: { - activities?: Schema$Activities; - customRichMediaEvents?: Schema$CustomRichMediaEvents; - dateRange?: Schema$DateRange; - dimensionFilters?: Schema$DimensionValue[]; - dimensions?: Schema$SortedDimension[]; - metricNames?: string[]; - } | null; - /** - * The report criteria for a report of type "CROSS_DIMENSION_REACH". - */ - crossDimensionReachCriteria?: { - breakdown?: Schema$SortedDimension[]; - dateRange?: Schema$DateRange; - dimension?: string; - dimensionFilters?: Schema$DimensionValue[]; - metricNames?: string[]; - overlapMetricNames?: string[]; - pivoted?: boolean; - } | null; - /** - * The report's email delivery settings. - */ - delivery?: { - emailOwner?: boolean; - emailOwnerDeliveryType?: string; - message?: string; - recipients?: Schema$Recipient[]; - } | null; - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The filename used when generating report files for this report. - */ - fileName?: string | null; - /** - * The report criteria for a report of type "FLOODLIGHT". - */ - floodlightCriteria?: { - customRichMediaEvents?: Schema$DimensionValue[]; - dateRange?: Schema$DateRange; - dimensionFilters?: Schema$DimensionValue[]; - dimensions?: Schema$SortedDimension[]; - floodlightConfigId?: Schema$DimensionValue; - metricNames?: string[]; - reportProperties?: { - includeAttributedIPConversions?: boolean; - includeUnattributedCookieConversions?: boolean; - includeUnattributedIPConversions?: boolean; - }; - } | null; - /** - * The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format. - */ - format?: string | null; - /** - * The unique ID identifying this report resource. - */ - id?: string | null; - /** - * The kind of resource this is, in this case dfareporting#report. - */ - kind?: string | null; - /** - * The timestamp (in milliseconds since epoch) of when this report was last modified. - */ - lastModifiedTime?: string | null; - /** - * The name of the report. - */ - name?: string | null; - /** - * The user profile id of the owner of this report. - */ - ownerProfileId?: string | null; - /** - * The report criteria for a report of type "PATH_TO_CONVERSION". - */ - pathToConversionCriteria?: { - activityFilters?: Schema$DimensionValue[]; - conversionDimensions?: Schema$SortedDimension[]; - customFloodlightVariables?: Schema$SortedDimension[]; - customRichMediaEvents?: Schema$DimensionValue[]; - dateRange?: Schema$DateRange; - floodlightConfigId?: Schema$DimensionValue; - metricNames?: string[]; - perInteractionDimensions?: Schema$SortedDimension[]; - reportProperties?: { - clicksLookbackWindow?: number; - impressionsLookbackWindow?: number; - includeAttributedIPConversions?: boolean; - includeUnattributedCookieConversions?: boolean; - includeUnattributedIPConversions?: boolean; - maximumClickInteractions?: number; - maximumImpressionInteractions?: number; - maximumInteractionGap?: number; - pivotOnInteractionPath?: boolean; - }; - } | null; - /** - * The report criteria for a report of type "REACH". - */ - reachCriteria?: { - activities?: Schema$Activities; - customRichMediaEvents?: Schema$CustomRichMediaEvents; - dateRange?: Schema$DateRange; - dimensionFilters?: Schema$DimensionValue[]; - dimensions?: Schema$SortedDimension[]; - enableAllDimensionCombinations?: boolean; - metricNames?: string[]; - reachByFrequencyMetricNames?: string[]; - } | null; - /** - * The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY". - */ - schedule?: { - active?: boolean; - every?: number; - expirationDate?: string; - repeats?: string; - repeatsOnWeekDays?: string[]; - runsOnDayOfMonth?: string; - startDate?: string; - } | null; - /** - * The subaccount ID to which this report belongs if applicable. - */ - subAccountId?: string | null; - /** - * The type of the report. - */ - type?: string | null; - } - /** - * Represents fields that are compatible to be selected for a report of type "STANDARD". - */ - export interface Schema$ReportCompatibleFields { - /** - * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. - */ - dimensionFilters?: Schema$Dimension[]; - /** - * Dimensions which are compatible to be selected in the "dimensions" section of the report. - */ - dimensions?: Schema$Dimension[]; - /** - * The kind of resource this is, in this case dfareporting#reportCompatibleFields. - */ - kind?: string | null; - /** - * Metrics which are compatible to be selected in the "metricNames" section of the report. - */ - metrics?: Schema$Metric[]; - /** - * Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. - */ - pivotedActivityMetrics?: Schema$Metric[]; - } - /** - * Represents the list of reports. - */ - export interface Schema$ReportList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The reports returned in this response. - */ - items?: Schema$Report[]; - /** - * The kind of list this is, in this case dfareporting#reportList. - */ - kind?: string | null; - /** - * Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted. - */ - nextPageToken?: string | null; - } - /** - * Reporting Configuration - */ - export interface Schema$ReportsConfiguration { - /** - * Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting. - */ - exposureToConversionEnabled?: boolean | null; - /** - * Default lookback windows for new advertisers in this account. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - */ - reportGenerationTimeZoneId?: string | null; - } - /** - * Rich Media Exit Override. - */ - export interface Schema$RichMediaExitOverride { - /** - * Click-through URL of this rich media exit override. Applicable if the enabled field is set to true. - */ - clickThroughUrl?: Schema$ClickThroughUrl; - /** - * Whether to use the clickThroughUrl. If false, the creative-level exit will be used. - */ - enabled?: boolean | null; - /** - * ID for the override to refer to a specific exit in the creative. - */ - exitId?: string | null; - } - /** - * A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives. - */ - export interface Schema$Rule { - /** - * A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field. - */ - assetId?: string | null; - /** - * A user-friendly name for this rule. This is a required field. - */ - name?: string | null; - /** - * A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field. - */ - targetingTemplateId?: string | null; - } - /** - * Contains properties of a site. - */ - export interface Schema$Site { - /** - * Account ID of this site. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Whether this site is approved. - */ - approved?: boolean | null; - /** - * Directory site associated with this site. This is a required field that is read-only after insertion. - */ - directorySiteId?: string | null; - /** - * Dimension value for the ID of the directory site. This is a read-only, auto-generated field. - */ - directorySiteIdDimensionValue?: Schema$DimensionValue; - /** - * ID of this site. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Dimension value for the ID of this site. This is a read-only, auto-generated field. - */ - idDimensionValue?: Schema$DimensionValue; - /** - * Key name of this site. This is a read-only, auto-generated field. - */ - keyName?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". - */ - kind?: string | null; - /** - * Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. - */ - name?: string | null; - /** - * Site contacts. - */ - siteContacts?: Schema$SiteContact[]; - /** - * Site-wide settings. - */ - siteSettings?: Schema$SiteSettings; - /** - * Subaccount ID of this site. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Site Contact - */ - export interface Schema$SiteContact { - /** - * Address of this site contact. - */ - address?: string | null; - /** - * Site contact type. - */ - contactType?: string | null; - /** - * Email address of this site contact. This is a required field. - */ - email?: string | null; - /** - * First name of this site contact. - */ - firstName?: string | null; - /** - * ID of this site contact. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Last name of this site contact. - */ - lastName?: string | null; - /** - * Primary phone number of this site contact. - */ - phone?: string | null; - /** - * Title or designation of this site contact. - */ - title?: string | null; - } - /** - * Site Settings - */ - export interface Schema$SiteSettings { - /** - * Whether active view creatives are disabled for this site. - */ - activeViewOptOut?: boolean | null; - /** - * Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. - */ - adBlockingOptOut?: boolean | null; - /** - * Site-wide creative settings. - */ - creativeSettings?: Schema$CreativeSettings; - /** - * Whether new cookies are disabled for this site. - */ - disableNewCookie?: boolean | null; - /** - * Lookback window settings for this site. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * Configuration settings for dynamic and image floodlight tags. - */ - tagSetting?: Schema$TagSetting; - /** - * Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. - */ - videoActiveViewOptOutTemplate?: boolean | null; - /** - * Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. - */ - vpaidAdapterChoiceTemplate?: string | null; - } - /** - * Site List Response - */ - export interface Schema$SitesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Site collection. - */ - sites?: Schema$Site[]; - } - /** - * Represents the dimensions of ads, placements, creatives, or creative assets. - */ - export interface Schema$Size { - /** - * Height of this size. Acceptable values are 0 to 32767, inclusive. - */ - height?: number | null; - /** - * IAB standard size. This is a read-only, auto-generated field. - */ - iab?: boolean | null; - /** - * ID of this size. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - */ - kind?: string | null; - /** - * Width of this size. Acceptable values are 0 to 32767, inclusive. - */ - width?: number | null; - } - /** - * Size List Response - */ - export interface Schema$SizesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse". - */ - kind?: string | null; - /** - * Size collection. - */ - sizes?: Schema$Size[]; - } - /** - * Skippable Settings - */ - export interface Schema$SkippableSetting { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". - */ - kind?: string | null; - /** - * Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. - */ - progressOffset?: Schema$VideoOffset; - /** - * Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. - */ - skipOffset?: Schema$VideoOffset; - /** - * Whether the user can skip creatives served to this placement. - */ - skippable?: boolean | null; - } - /** - * Represents a sorted dimension. - */ - export interface Schema$SortedDimension { - /** - * The kind of resource this is, in this case dfareporting#sortedDimension. - */ - kind?: string | null; - /** - * The name of the dimension. - */ - name?: string | null; - /** - * An optional sort order for the dimension column. - */ - sortOrder?: string | null; - } - /** - * Contains properties of a Campaign Manager subaccount. - */ - export interface Schema$Subaccount { - /** - * ID of the account that contains this subaccount. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * IDs of the available user role permissions for this subaccount. - */ - availablePermissionIds?: string[] | null; - /** - * ID of this subaccount. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount". - */ - kind?: string | null; - /** - * Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account. - */ - name?: string | null; - } - /** - * Subaccount List Response - */ - export interface Schema$SubaccountsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Subaccount collection. - */ - subaccounts?: Schema$Subaccount[]; - } - /** - * Placement Tag Data - */ - export interface Schema$TagData { - /** - * Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. - */ - adId?: string | null; - /** - * Tag string to record a click. - */ - clickTag?: string | null; - /** - * Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. - */ - creativeId?: string | null; - /** - * TagData tag format of this tag. - */ - format?: string | null; - /** - * Tag string for serving an ad. - */ - impressionTag?: string | null; - } - /** - * Tag Settings - */ - export interface Schema$TagSetting { - /** - * Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. - */ - additionalKeyValues?: string | null; - /** - * Whether static landing page URLs should be included in the tags. This setting applies only to placements. - */ - includeClickThroughUrls?: boolean | null; - /** - * Whether click-tracking string should be included in the tags. - */ - includeClickTracking?: boolean | null; - /** - * Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. - */ - keywordOption?: string | null; - } - /** - * Dynamic and Image Tag Settings. - */ - export interface Schema$TagSettings { - /** - * Whether dynamic floodlight tags are enabled. - */ - dynamicTagEnabled?: boolean | null; - /** - * Whether image tags are enabled. - */ - imageTagEnabled?: boolean | null; - } - /** - * Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource. - */ - export interface Schema$TargetableRemarketingList { - /** - * Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. - */ - accountId?: string | null; - /** - * Whether this targetable remarketing list is active. - */ - active?: boolean | null; - /** - * Dimension value for the advertiser ID that owns this targetable remarketing list. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Targetable remarketing list description. - */ - description?: string | null; - /** - * Targetable remarketing list ID. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList". - */ - kind?: string | null; - /** - * Number of days that a user should remain in the targetable remarketing list without an impression. - */ - lifeSpan?: string | null; - /** - * Number of users currently in the list. This is a read-only field. - */ - listSize?: string | null; - /** - * Product from which this targetable remarketing list was originated. - */ - listSource?: string | null; - /** - * Name of the targetable remarketing list. Is no greater than 128 characters long. - */ - name?: string | null; - /** - * Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. - */ - subaccountId?: string | null; - } - /** - * Targetable remarketing list response - */ - export interface Schema$TargetableRemarketingListsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Targetable remarketing list collection. - */ - targetableRemarketingLists?: Schema$TargetableRemarketingList[]; - } - /** - * Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads. - */ - export interface Schema$TargetingTemplate { - /** - * Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. - */ - accountId?: string | null; - /** - * Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert. - */ - advertiserId?: string | null; - /** - * Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. - */ - advertiserIdDimensionValue?: Schema$DimensionValue; - /** - * Time and day targeting criteria. - */ - dayPartTargeting?: Schema$DayPartTargeting; - /** - * Geographical targeting criteria. - */ - geoTargeting?: Schema$GeoTargeting; - /** - * ID of this targeting template. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Key-value targeting criteria. - */ - keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate". - */ - kind?: string | null; - /** - * Language targeting criteria. - */ - languageTargeting?: Schema$LanguageTargeting; - /** - * Remarketing list targeting criteria. - */ - listTargetingExpression?: Schema$ListTargetingExpression; - /** - * Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser. - */ - name?: string | null; - /** - * Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert. - */ - subaccountId?: string | null; - /** - * Technology platform targeting criteria. - */ - technologyTargeting?: Schema$TechnologyTargeting; - } - /** - * Targeting Template List Response - */ - export interface Schema$TargetingTemplatesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * Targeting template collection. - */ - targetingTemplates?: Schema$TargetingTemplate[]; - } - /** - * Target Window. - */ - export interface Schema$TargetWindow { - /** - * User-entered value. - */ - customHtml?: string | null; - /** - * Type of browser window for which the backup image of the flash creative can be displayed. - */ - targetWindowOption?: string | null; - } - /** - * Technology Targeting. - */ - export interface Schema$TechnologyTargeting { - /** - * Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated. - */ - browsers?: Schema$Browser[]; - /** - * Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated. - */ - connectionTypes?: Schema$ConnectionType[]; - /** - * Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes. - */ - mobileCarriers?: Schema$MobileCarrier[]; - /** - * Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system. - */ - operatingSystems?: Schema$OperatingSystem[]; - /** - * Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems. - */ - operatingSystemVersions?: Schema$OperatingSystemVersion[]; - /** - * Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated. - */ - platformTypes?: Schema$PlatformType[]; - } - /** - * Third Party Authentication Token - */ - export interface Schema$ThirdPartyAuthenticationToken { - /** - * Name of the third-party authentication token. - */ - name?: string | null; - /** - * Value of the third-party authentication token. This is a read-only, auto-generated field. - */ - value?: string | null; - } - /** - * Third-party Tracking URL. - */ - export interface Schema$ThirdPartyTrackingUrl { - /** - * Third-party URL type for in-stream video and in-stream audio creatives. - */ - thirdPartyUrlType?: string | null; - /** - * URL for the specified third-party URL type. - */ - url?: string | null; - } - /** - * Transcode Settings - */ - export interface Schema$TranscodeSetting { - /** - * Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. - */ - enabledVideoFormats?: number[] | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". - */ - kind?: string | null; - } - /** - * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. - */ - export interface Schema$UniversalAdId { - /** - * Registry used for the Ad ID value. - */ - registry?: string | null; - /** - * ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. - */ - value?: string | null; - } - /** - * User Defined Variable configuration. - */ - export interface Schema$UserDefinedVariableConfiguration { - /** - * Data type for the variable. This is a required field. - */ - dataType?: string | null; - /** - * User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>". - */ - reportName?: string | null; - /** - * Variable name in the tag. This is a required field. - */ - variableType?: string | null; - } - /** - * Represents a UserProfile resource. - */ - export interface Schema$UserProfile { - /** - * The account ID to which this profile belongs. - */ - accountId?: string | null; - /** - * The account name this profile belongs to. - */ - accountName?: string | null; - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The kind of resource this is, in this case dfareporting#userProfile. - */ - kind?: string | null; - /** - * The unique ID of the user profile. - */ - profileId?: string | null; - /** - * The sub account ID this profile belongs to if applicable. - */ - subAccountId?: string | null; - /** - * The sub account name this profile belongs to if applicable. - */ - subAccountName?: string | null; - /** - * The user name. - */ - userName?: string | null; - } - /** - * Represents the list of user profiles. - */ - export interface Schema$UserProfileList { - /** - * The eTag of this response for caching purposes. - */ - etag?: string | null; - /** - * The user profiles returned in this response. - */ - items?: Schema$UserProfile[]; - /** - * The kind of list this is, in this case dfareporting#userProfileList. - */ - kind?: string | null; - } - /** - * Contains properties of auser role, which is used to manage user access. - */ - export interface Schema$UserRole { - /** - * Account ID of this user role. This is a read-only field that can be left blank. - */ - accountId?: string | null; - /** - * Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions. - */ - defaultUserRole?: boolean | null; - /** - * ID of this user role. This is a read-only, auto-generated field. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole". - */ - kind?: string | null; - /** - * Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account. - */ - name?: string | null; - /** - * ID of the user role that this user role is based on or copied from. This is a required field. - */ - parentUserRoleId?: string | null; - /** - * List of permissions associated with this user role. - */ - permissions?: Schema$UserRolePermission[]; - /** - * Subaccount ID of this user role. This is a read-only field that can be left blank. - */ - subaccountId?: string | null; - } - /** - * Contains properties of a user role permission. - */ - export interface Schema$UserRolePermission { - /** - * Levels of availability for a user role permission. - */ - availability?: string | null; - /** - * ID of this user role permission. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission". - */ - kind?: string | null; - /** - * Name of this user role permission. - */ - name?: string | null; - /** - * ID of the permission group that this user role permission belongs to. - */ - permissionGroupId?: string | null; - } - /** - * Represents a grouping of related user role permissions. - */ - export interface Schema$UserRolePermissionGroup { - /** - * ID of this user role permission. - */ - id?: string | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup". - */ - kind?: string | null; - /** - * Name of this user role permission group. - */ - name?: string | null; - } - /** - * User Role Permission Group List Response - */ - export interface Schema$UserRolePermissionGroupsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse". - */ - kind?: string | null; - /** - * User role permission group collection. - */ - userRolePermissionGroups?: Schema$UserRolePermissionGroup[]; - } - /** - * User Role Permission List Response - */ - export interface Schema$UserRolePermissionsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse". - */ - kind?: string | null; - /** - * User role permission collection. - */ - userRolePermissions?: Schema$UserRolePermission[]; - } - /** - * User Role List Response - */ - export interface Schema$UserRolesListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse". - */ - kind?: string | null; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: string | null; - /** - * User role collection. - */ - userRoles?: Schema$UserRole[]; - } - /** - * Contains information about supported video formats. - */ - export interface Schema$VideoFormat { - /** - * File type of the video format. - */ - fileType?: string | null; - /** - * ID of the video format. - */ - id?: number | null; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat". - */ - kind?: string | null; - /** - * The resolution of this video format. - */ - resolution?: Schema$Size; - /** - * The target bit rate of this video format. - */ - targetBitRate?: number | null; - } - /** - * Video Format List Response - */ - export interface Schema$VideoFormatsListResponse { - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse". - */ - kind?: string | null; - /** - * Video format collection. - */ - videoFormats?: Schema$VideoFormat[]; - } - /** - * Video Offset - */ - export interface Schema$VideoOffset { - /** - * Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - */ - offsetPercentage?: number | null; - /** - * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. - */ - offsetSeconds?: number | null; - } - /** - * Video Settings - */ - export interface Schema$VideoSettings { - /** - * Settings for the companion creatives of video creatives served to this placement. - */ - companionSettings?: Schema$CompanionSetting; - /** - * Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". - */ - kind?: string | null; - /** - * Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - */ - orientation?: string | null; - /** - * Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden. - */ - skippableSettings?: Schema$SkippableSetting; - /** - * Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden. - */ - transcodeSettings?: Schema$TranscodeSetting; - } - - export class Resource$Accountactiveadsummaries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accountActiveAdSummaries.get - * @desc Gets the account's active ad summary by account ID. - * @alias dfareporting.accountActiveAdSummaries.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.summaryAccountId Account 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$Accountactiveadsummaries$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accountactiveadsummaries$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accountactiveadsummaries$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Accountactiveadsummaries$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountactiveadsummaries$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountactiveadsummaries$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'summaryAccountId'], - pathParams: ['profileId', 'summaryAccountId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Accountactiveadsummaries$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Account ID. - */ - summaryAccountId?: string; - } - - export class Resource$Accountpermissiongroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accountPermissionGroups.get - * @desc Gets one account permission group by ID. - * @alias dfareporting.accountPermissionGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account permission group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Accountpermissiongroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accountpermissiongroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accountpermissiongroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Accountpermissiongroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountpermissiongroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissiongroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountPermissionGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountPermissionGroups.list - * @desc Retrieves the list of account permission groups. - * @alias dfareporting.accountPermissionGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Accountpermissiongroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accountpermissiongroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accountpermissiongroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Accountpermissiongroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$AccountPermissionGroupsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountpermissiongroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissiongroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountPermissionGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Accountpermissiongroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account permission group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountpermissiongroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Accountpermissions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accountPermissions.get - * @desc Gets one account permission by ID. - * @alias dfareporting.accountPermissions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account permission ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Accountpermissions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accountpermissions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accountpermissions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Accountpermissions$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountpermissions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountPermissions/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountPermissions.list - * @desc Retrieves the list of account permissions. - * @alias dfareporting.accountPermissions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Accountpermissions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accountpermissions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accountpermissions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Accountpermissions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountpermissions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountpermissions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountPermissions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Accountpermissions$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account permission ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountpermissions$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Accounts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accounts.get - * @desc Gets one account by ID. - * @alias dfareporting.accounts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - 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://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accounts/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accounts.list - * @desc Retrieves the list of accounts, possibly filtered. This method supports paging. - * @alias dfareporting.accounts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active accounts. Don't set this field to select both active and non-active accounts. - * @param {string=} params.ids Select only accounts with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$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://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/accounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accounts.patch - * @desc Updates an existing account. This method supports patch semantics. - * @alias dfareporting.accounts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Account ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Account} params.resource Request body data - * @param {object} [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$Accounts$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accounts$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Accounts$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/accounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accounts.update - * @desc Updates an existing account. - * @alias dfareporting.accounts.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Account} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - update( - params?: Params$Resource$Accounts$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Accounts$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Accounts$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Accounts$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/accounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - 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; - - /** - * Account ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accounts$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active accounts. Don't set this field to select both active and non-active accounts. - */ - active?: boolean; - /** - * Select only accounts with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Accounts$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } - export interface Params$Resource$Accounts$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } - - export class Resource$Accountuserprofiles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.accountUserProfiles.get - * @desc Gets one account user profile by ID. - * @alias dfareporting.accountUserProfiles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User profile ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Accountuserprofiles$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accountuserprofiles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accountuserprofiles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountUserProfiles/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountUserProfiles.insert - * @desc Inserts a new account user profile. - * @alias dfareporting.accountUserProfiles.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} params.resource Request body data - * @param {object} [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$Accountuserprofiles$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Accountuserprofiles$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Accountuserprofiles$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountUserProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountUserProfiles.list - * @desc Retrieves a list of account user profiles, possibly filtered. This method supports paging. - * @alias dfareporting.accountUserProfiles.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active user profiles. - * @param {string=} params.ids Select only user profiles with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only user profiles with the specified subaccount ID. - * @param {string=} params.userRoleId Select only user profiles with the specified user role 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$Accountuserprofiles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accountuserprofiles$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accountuserprofiles$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountUserProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.accountUserProfiles.patch - * @desc Updates an existing account user profile. This method supports patch semantics. - * @alias dfareporting.accountUserProfiles.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User profile ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} params.resource Request body data - * @param {object} [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$Accountuserprofiles$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accountuserprofiles$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accountuserprofiles$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountUserProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.accountUserProfiles.update - * @desc Updates an existing account user profile. - * @alias dfareporting.accountUserProfiles.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AccountUserProfile} params.resource Request body data - * @param {object} [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$Accountuserprofiles$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Accountuserprofiles$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Accountuserprofiles$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Accountuserprofiles$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountuserprofiles$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountuserprofiles$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/accountUserProfiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Accountuserprofiles$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Accountuserprofiles$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - export interface Params$Resource$Accountuserprofiles$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active user profiles. - */ - active?: boolean; - /** - * Select only user profiles with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only user profiles with the specified subaccount ID. - */ - subaccountId?: string; - /** - * Select only user profiles with the specified user role ID. - */ - userRoleId?: string; - } - export interface Params$Resource$Accountuserprofiles$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - export interface Params$Resource$Accountuserprofiles$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountUserProfile; - } - - export class Resource$Ads { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.ads.get - * @desc Gets one ad by ID. - * @alias dfareporting.ads.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Ad ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Ads$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Ads$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Ads$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Ads$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/ads/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.ads.insert - * @desc Inserts a new ad. - * @alias dfareporting.ads.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} params.resource Request body data - * @param {object} [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$Ads$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Ads$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Ads$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Ads$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/ads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.ads.list - * @desc Retrieves a list of ads, possibly filtered. This method supports paging. - * @alias dfareporting.ads.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active ads. - * @param {string=} params.advertiserId Select only ads with this advertiser ID. - * @param {boolean=} params.archived Select only archived ads. - * @param {string=} params.audienceSegmentIds Select only ads with these audience segment IDs. - * @param {string=} params.campaignIds Select only ads with these campaign IDs. - * @param {string=} params.compatibility Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. - * @param {string=} params.creativeIds Select only ads with these creative IDs assigned. - * @param {string=} params.creativeOptimizationConfigurationIds Select only ads with these creative optimization configuration IDs. - * @param {boolean=} params.dynamicClickTracker Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. - * @param {string=} params.ids Select only ads with these IDs. - * @param {string=} params.landingPageIds Select only ads with these landing page IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.overriddenEventTagId Select only ads with this event tag override ID. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.placementIds Select only ads with these placement IDs assigned. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.remarketingListIds Select only ads whose list targeting expression use these remarketing list IDs. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". - * @param {string=} params.sizeIds Select only ads with these size IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {boolean=} params.sslCompliant Select only ads that are SSL-compliant. - * @param {boolean=} params.sslRequired Select only ads that require SSL. - * @param {string=} params.type Select only ads with these types. - * @param {object} [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$Ads$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Ads$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Ads$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Ads$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/ads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.ads.patch - * @desc Updates an existing ad. This method supports patch semantics. - * @alias dfareporting.ads.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Ad ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} params.resource Request body data - * @param {object} [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$Ads$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Ads$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Ads$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Ads$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/ads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.ads.update - * @desc Updates an existing ad. - * @alias dfareporting.ads.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Ad} params.resource Request body data - * @param {object} [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$Ads$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Ads$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Ads$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Ads$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Ads$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Ads$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/ads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Ads$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Ad ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Ads$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - export interface Params$Resource$Ads$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active ads. - */ - active?: boolean; - /** - * Select only ads with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only archived ads. - */ - archived?: boolean; - /** - * Select only ads with these audience segment IDs. - */ - audienceSegmentIds?: string[]; - /** - * Select only ads with these campaign IDs. - */ - campaignIds?: string[]; - /** - * Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. - */ - compatibility?: string; - /** - * Select only ads with these creative IDs assigned. - */ - creativeIds?: string[]; - /** - * Select only ads with these creative optimization configuration IDs. - */ - creativeOptimizationConfigurationIds?: string[]; - /** - * Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. - */ - dynamicClickTracker?: boolean; - /** - * Select only ads with these IDs. - */ - ids?: string[]; - /** - * Select only ads with these landing page IDs. - */ - landingPageIds?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only ads with this event tag override ID. - */ - overriddenEventTagId?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only ads with these placement IDs assigned. - */ - placementIds?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only ads whose list targeting expression use these remarketing list IDs. - */ - remarketingListIds?: string[]; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". - */ - searchString?: string; - /** - * Select only ads with these size IDs. - */ - sizeIds?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only ads that are SSL-compliant. - */ - sslCompliant?: boolean; - /** - * Select only ads that require SSL. - */ - sslRequired?: boolean; - /** - * Select only ads with these types. - */ - type?: string[]; - } - export interface Params$Resource$Ads$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Ad ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - export interface Params$Resource$Ads$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Ad; - } - - export class Resource$Advertisergroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.advertiserGroups.delete - * @desc Deletes an existing advertiser group. - * @alias dfareporting.advertiserGroups.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Advertisergroups$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Advertisergroups$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Advertisergroups$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserGroups.get - * @desc Gets one advertiser group by ID. - * @alias dfareporting.advertiserGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Advertisergroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertisergroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertisergroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserGroups.insert - * @desc Inserts a new advertiser group. - * @alias dfareporting.advertiserGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} params.resource Request body data - * @param {object} [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$Advertisergroups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Advertisergroups$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Advertisergroups$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserGroups.list - * @desc Retrieves a list of advertiser groups, possibly filtered. This method supports paging. - * @alias dfareporting.advertiserGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only advertiser groups with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Advertisergroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Advertisergroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisergroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Advertisergroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.advertiserGroups.patch - * @desc Updates an existing advertiser group. This method supports patch semantics. - * @alias dfareporting.advertiserGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} params.resource Request body data - * @param {object} [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$Advertisergroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Advertisergroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Advertisergroups$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserGroups.update - * @desc Updates an existing advertiser group. - * @alias dfareporting.advertiserGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().AdvertiserGroup} params.resource Request body data - * @param {object} [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$Advertisergroups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Advertisergroups$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Advertisergroups$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Advertisergroups$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisergroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisergroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Advertisergroups$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisergroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisergroups$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - export interface Params$Resource$Advertisergroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only advertiser groups with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Advertisergroups$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - export interface Params$Resource$Advertisergroups$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AdvertiserGroup; - } - - export class Resource$Advertiserlandingpages { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.advertiserLandingPages.get - * @desc Gets one landing page by ID. - * @alias dfareporting.advertiserLandingPages.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Landing page ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Advertiserlandingpages$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertiserlandingpages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertiserlandingpages$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserLandingPages/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserLandingPages.insert - * @desc Inserts a new landing page. - * @alias dfareporting.advertiserLandingPages.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} params.resource Request body data - * @param {object} [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$Advertiserlandingpages$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Advertiserlandingpages$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Advertiserlandingpages$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserLandingPages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserLandingPages.list - * @desc Retrieves a list of landing pages. - * @alias dfareporting.advertiserLandingPages.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only landing pages that belong to these advertisers. - * @param {boolean=} params.archived Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. - * @param {string=} params.campaignIds Select only landing pages that are associated with these campaigns. - * @param {string=} params.ids Select only landing pages with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only landing pages that belong to this subaccount. - * @param {object} [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$Advertiserlandingpages$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Advertiserlandingpages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertiserlandingpages$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserLandingPages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.advertiserLandingPages.patch - * @desc Updates an existing landing page. This method supports patch semantics. - * @alias dfareporting.advertiserLandingPages.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Landing page ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} params.resource Request body data - * @param {object} [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$Advertiserlandingpages$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Advertiserlandingpages$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Advertiserlandingpages$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserLandingPages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertiserLandingPages.update - * @desc Updates an existing landing page. - * @alias dfareporting.advertiserLandingPages.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().LandingPage} params.resource Request body data - * @param {object} [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$Advertiserlandingpages$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Advertiserlandingpages$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Advertiserlandingpages$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Advertiserlandingpages$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertiserlandingpages$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertiserlandingpages$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertiserLandingPages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Advertiserlandingpages$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Landing page ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertiserlandingpages$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - export interface Params$Resource$Advertiserlandingpages$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only landing pages that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. - */ - archived?: boolean; - /** - * Select only landing pages that are associated with these campaigns. - */ - campaignIds?: string[]; - /** - * Select only landing pages with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only landing pages that belong to this subaccount. - */ - subaccountId?: string; - } - export interface Params$Resource$Advertiserlandingpages$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Landing page ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - export interface Params$Resource$Advertiserlandingpages$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LandingPage; - } - - export class Resource$Advertisers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.advertisers.get - * @desc Gets one advertiser by ID. - * @alias dfareporting.advertisers.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Advertisers$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Advertisers$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertisers$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Advertisers$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertisers/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertisers.insert - * @desc Inserts a new advertiser. - * @alias dfareporting.advertisers.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} params.resource Request body data - * @param {object} [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$Advertisers$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Advertisers$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Advertisers$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Advertisers$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertisers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertisers.list - * @desc Retrieves a list of advertisers, possibly filtered. This method supports paging. - * @alias dfareporting.advertisers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserGroupIds Select only advertisers with these advertiser group IDs. - * @param {string=} params.floodlightConfigurationIds Select only advertisers with these floodlight configuration IDs. - * @param {string=} params.ids Select only advertisers with these IDs. - * @param {boolean=} params.includeAdvertisersWithoutGroupsOnly Select only advertisers which do not belong to any advertiser group. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {boolean=} params.onlyParent Select only advertisers which use another advertiser's floodlight configuration. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.status Select only advertisers with the specified status. - * @param {string=} params.subaccountId Select only advertisers with these subaccount IDs. - * @param {object} [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$Advertisers$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Advertisers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Advertisers$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertisers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertisers.patch - * @desc Updates an existing advertiser. This method supports patch semantics. - * @alias dfareporting.advertisers.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Advertiser ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} params.resource Request body data - * @param {object} [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$Advertisers$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Advertisers$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Advertisers$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Advertisers$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertisers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.advertisers.update - * @desc Updates an existing advertiser. - * @alias dfareporting.advertisers.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Advertiser} params.resource Request body data - * @param {object} [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$Advertisers$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Advertisers$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Advertisers$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Advertisers$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/advertisers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Advertisers$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Advertisers$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - export interface Params$Resource$Advertisers$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only advertisers with these advertiser group IDs. - */ - advertiserGroupIds?: string[]; - /** - * Select only advertisers with these floodlight configuration IDs. - */ - floodlightConfigurationIds?: string[]; - /** - * Select only advertisers with these IDs. - */ - ids?: string[]; - /** - * Select only advertisers which do not belong to any advertiser group. - */ - includeAdvertisersWithoutGroupsOnly?: boolean; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only advertisers which use another advertiser's floodlight configuration. - */ - onlyParent?: boolean; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only advertisers with the specified status. - */ - status?: string; - /** - * Select only advertisers with these subaccount IDs. - */ - subaccountId?: string; - } - export interface Params$Resource$Advertisers$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - export interface Params$Resource$Advertisers$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Advertiser; - } - - export class Resource$Browsers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.browsers.list - * @desc Retrieves a list of browsers. - * @alias dfareporting.browsers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Browsers$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Browsers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Browsers$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Browsers$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Browsers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Browsers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/browsers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Browsers$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Campaigncreativeassociations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.campaignCreativeAssociations.insert - * @desc Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. - * @alias dfareporting.campaignCreativeAssociations.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Campaign ID in this association. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CampaignCreativeAssociation} params.resource Request body data - * @param {object} [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$Campaigncreativeassociations$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Campaigncreativeassociations$Insert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Campaigncreativeassociations$Insert, - callback: BodyResponseCallback - ): void; - insert( - callback: BodyResponseCallback - ): void; - insert( - paramsOrCallback?: - | Params$Resource$Campaigncreativeassociations$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Campaigncreativeassociations$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigncreativeassociations$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaignCreativeAssociations.list - * @desc Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. - * @alias dfareporting.campaignCreativeAssociations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.campaignId Campaign ID in this association. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Campaigncreativeassociations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Campaigncreativeassociations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse - > - ): void; - list( - params: Params$Resource$Campaigncreativeassociations$List, - callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Campaigncreativeassociations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$CampaignCreativeAssociationsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Campaigncreativeassociations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigncreativeassociations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$CampaignCreativeAssociationsListResponse - >(parameters); - } - } - } - - export interface Params$Resource$Campaigncreativeassociations$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Campaign ID in this association. - */ - campaignId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CampaignCreativeAssociation; - } - export interface Params$Resource$Campaigncreativeassociations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Campaign ID in this association. - */ - campaignId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Campaigns { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.campaigns.get - * @desc Gets one campaign by ID. - * @alias dfareporting.campaigns.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Campaign ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Campaigns$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Campaigns$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Campaigns$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Campaigns$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/campaigns/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaigns.insert - * @desc Inserts a new campaign. - * @alias dfareporting.campaigns.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} params.resource Request body data - * @param {object} [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$Campaigns$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Campaigns$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Campaigns$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Campaigns$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/campaigns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaigns.list - * @desc Retrieves a list of campaigns, possibly filtered. This method supports paging. - * @alias dfareporting.campaigns.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups. - * @param {string=} params.advertiserIds Select only campaigns that belong to these advertisers. - * @param {boolean=} params.archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. - * @param {boolean=} params.atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity. - * @param {string=} params.excludedIds Exclude campaigns with these IDs. - * @param {string=} params.ids Select only campaigns with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.overriddenEventTagId Select only campaigns that have overridden this event tag ID. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only campaigns that belong to this subaccount. - * @param {object} [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$Campaigns$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Campaigns$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Campaigns$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Campaigns$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/campaigns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaigns.patch - * @desc Updates an existing campaign. This method supports patch semantics. - * @alias dfareporting.campaigns.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Campaign ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} params.resource Request body data - * @param {object} [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$Campaigns$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Campaigns$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Campaigns$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Campaigns$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/campaigns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.campaigns.update - * @desc Updates an existing campaign. - * @alias dfareporting.campaigns.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Campaign} params.resource Request body data - * @param {object} [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$Campaigns$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Campaigns$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Campaigns$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Campaigns$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Campaigns$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/campaigns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Campaigns$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Campaign ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Campaigns$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - export interface Params$Resource$Campaigns$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only campaigns whose advertisers belong to these advertiser groups. - */ - advertiserGroupIds?: string[]; - /** - * Select only campaigns that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. - */ - archived?: boolean; - /** - * Select only campaigns that have at least one optimization activity. - */ - atLeastOneOptimizationActivity?: boolean; - /** - * Exclude campaigns with these IDs. - */ - excludedIds?: string[]; - /** - * Select only campaigns with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only campaigns that have overridden this event tag ID. - */ - overriddenEventTagId?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only campaigns that belong to this subaccount. - */ - subaccountId?: string; - } - export interface Params$Resource$Campaigns$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Campaign ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - export interface Params$Resource$Campaigns$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - - export class Resource$Changelogs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.changeLogs.get - * @desc Gets one change log by ID. - * @alias dfareporting.changeLogs.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Change log ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Changelogs$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Changelogs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Changelogs$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Changelogs$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Changelogs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/changeLogs/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.changeLogs.list - * @desc Retrieves a list of change logs. This method supports paging. - * @alias dfareporting.changeLogs.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.action Select only change logs with the specified action. - * @param {string=} params.ids Select only change logs with these IDs. - * @param {string=} params.maxChangeTime Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.minChangeTime Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - * @param {string=} params.objectIds Select only change logs with these object IDs. - * @param {string=} params.objectType Select only change logs with the specified object type. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Select only change logs whose object ID, user name, old or new values match the search string. - * @param {string=} params.userProfileIds Select only change logs with these user profile IDs. - * @param {object} [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$Changelogs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Changelogs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Changelogs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Changelogs$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Changelogs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/changeLogs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Changelogs$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Change log ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Changelogs$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only change logs with the specified action. - */ - action?: string; - /** - * Select only change logs with these IDs. - */ - ids?: string[]; - /** - * Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - */ - maxChangeTime?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. - */ - minChangeTime?: string; - /** - * Select only change logs with these object IDs. - */ - objectIds?: string[]; - /** - * Select only change logs with the specified object type. - */ - objectType?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only change logs whose object ID, user name, old or new values match the search string. - */ - searchString?: string; - /** - * Select only change logs with these user profile IDs. - */ - userProfileIds?: string[]; - } - - export class Resource$Cities { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.cities.list - * @desc Retrieves a list of cities, possibly filtered. - * @alias dfareporting.cities.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.countryDartIds Select only cities from these countries. - * @param {string=} params.dartIds Select only cities with these DART IDs. - * @param {string=} params.namePrefix Select only cities with names starting with this prefix. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.regionDartIds Select only cities from these regions. - * @param {object} [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$Cities$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Cities$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Cities$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Cities$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Cities$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Cities$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/cities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Cities$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only cities from these countries. - */ - countryDartIds?: string[]; - /** - * Select only cities with these DART IDs. - */ - dartIds?: string[]; - /** - * Select only cities with names starting with this prefix. - */ - namePrefix?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only cities from these regions. - */ - regionDartIds?: string[]; - } - - export class Resource$Connectiontypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.connectionTypes.get - * @desc Gets one connection type by ID. - * @alias dfareporting.connectionTypes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Connection type ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Connectiontypes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Connectiontypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Connectiontypes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Connectiontypes$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Connectiontypes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Connectiontypes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/connectionTypes/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.connectionTypes.list - * @desc Retrieves a list of connection types. - * @alias dfareporting.connectionTypes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Connectiontypes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Connectiontypes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Connectiontypes$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Connectiontypes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Connectiontypes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Connectiontypes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/connectionTypes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Connectiontypes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Connection type ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Connectiontypes$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Contentcategories { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.contentCategories.delete - * @desc Deletes an existing content category. - * @alias dfareporting.contentCategories.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Contentcategories$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Contentcategories$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Contentcategories$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Contentcategories$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/contentCategories/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.contentCategories.get - * @desc Gets one content category by ID. - * @alias dfareporting.contentCategories.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Contentcategories$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Contentcategories$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Contentcategories$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Contentcategories$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/contentCategories/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.contentCategories.insert - * @desc Inserts a new content category. - * @alias dfareporting.contentCategories.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} params.resource Request body data - * @param {object} [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$Contentcategories$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Contentcategories$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Contentcategories$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Contentcategories$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/contentCategories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.contentCategories.list - * @desc Retrieves a list of content categories, possibly filtered. This method supports paging. - * @alias dfareporting.contentCategories.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only content categories with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Contentcategories$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Contentcategories$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Contentcategories$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Contentcategories$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/contentCategories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.contentCategories.patch - * @desc Updates an existing content category. This method supports patch semantics. - * @alias dfareporting.contentCategories.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Content category ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} params.resource Request body data - * @param {object} [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$Contentcategories$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Contentcategories$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Contentcategories$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Contentcategories$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/contentCategories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.contentCategories.update - * @desc Updates an existing content category. - * @alias dfareporting.contentCategories.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ContentCategory} params.resource Request body data - * @param {object} [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$Contentcategories$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Contentcategories$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Contentcategories$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Contentcategories$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Contentcategories$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Contentcategories$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/contentCategories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Contentcategories$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Contentcategories$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Contentcategories$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - export interface Params$Resource$Contentcategories$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only content categories with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Contentcategories$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Content category ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - export interface Params$Resource$Contentcategories$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ContentCategory; - } - - export class Resource$Conversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.conversions.batchinsert - * @desc Inserts conversions. - * @alias dfareporting.conversions.batchinsert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ConversionsBatchInsertRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - batchinsert( - params?: Params$Resource$Conversions$Batchinsert, - options?: MethodOptions - ): GaxiosPromise; - batchinsert( - params: Params$Resource$Conversions$Batchinsert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchinsert( - params: Params$Resource$Conversions$Batchinsert, - callback: BodyResponseCallback - ): void; - batchinsert( - callback: BodyResponseCallback - ): void; - batchinsert( - paramsOrCallback?: - | Params$Resource$Conversions$Batchinsert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Conversions$Batchinsert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Conversions$Batchinsert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/conversions/batchinsert' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.conversions.batchupdate - * @desc Updates existing conversions. - * @alias dfareporting.conversions.batchupdate - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().ConversionsBatchUpdateRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - batchupdate( - params?: Params$Resource$Conversions$Batchupdate, - options?: MethodOptions - ): GaxiosPromise; - batchupdate( - params: Params$Resource$Conversions$Batchupdate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchupdate( - params: Params$Resource$Conversions$Batchupdate, - callback: BodyResponseCallback - ): void; - batchupdate( - callback: BodyResponseCallback - ): void; - batchupdate( - paramsOrCallback?: - | Params$Resource$Conversions$Batchupdate - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Conversions$Batchupdate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Conversions$Batchupdate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/conversions/batchupdate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Conversions$Batchinsert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ConversionsBatchInsertRequest; - } - export interface Params$Resource$Conversions$Batchupdate - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ConversionsBatchUpdateRequest; - } - - export class Resource$Countries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.countries.get - * @desc Gets one country by ID. - * @alias dfareporting.countries.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dartId Country DART ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Countries$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Countries$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Countries$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Countries$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Countries$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Countries$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/countries/{dartId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'dartId'], - pathParams: ['dartId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.countries.list - * @desc Retrieves a list of countries. - * @alias dfareporting.countries.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Countries$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Countries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Countries$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Countries$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Countries$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Countries$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/countries' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Countries$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Country DART ID. - */ - dartId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Countries$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Creativeassets { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creativeAssets.insert - * @desc Inserts a new creative asset. - * @alias dfareporting.creativeAssets.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.advertiserId Advertiser ID of this creative. This is a required field. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} params.resource Media resource metadata - * @param {object} params.media Media object - * @param {string} params.media.mimeType Media mime-type - * @param {string|object} params.media.body Media body contents - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - insert( - params?: Params$Resource$Creativeassets$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creativeassets$Insert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creativeassets$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creativeassets$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativeassets$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativeassets$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - mediaUrl: ( - rootUrl + - '/upload/dfareporting/v3.2/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['advertiserId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativeassets$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Advertiser ID of this creative. This is a required field. - */ - advertiserId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeAssetMetadata; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - - export class Resource$Creativefields { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creativeFields.delete - * @desc Deletes an existing creative field. - * @alias dfareporting.creativeFields.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Creativefields$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Creativefields$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Creativefields$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Creativefields$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.get - * @desc Gets one creative field by ID. - * @alias dfareporting.creativeFields.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Creativefields$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Creativefields$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Creativefields$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Creativefields$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.insert - * @desc Inserts a new creative field. - * @alias dfareporting.creativeFields.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} params.resource Request body data - * @param {object} [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$Creativefields$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creativefields$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creativefields$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creativefields$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.list - * @desc Retrieves a list of creative fields, possibly filtered. This method supports paging. - * @alias dfareporting.creativeFields.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only creative fields that belong to these advertisers. - * @param {string=} params.ids Select only creative fields with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Creativefields$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Creativefields$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Creativefields$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Creativefields$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.patch - * @desc Updates an existing creative field. This method supports patch semantics. - * @alias dfareporting.creativeFields.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative Field ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} params.resource Request body data - * @param {object} [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$Creativefields$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Creativefields$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Creativefields$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Creativefields$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFields.update - * @desc Updates an existing creative field. - * @alias dfareporting.creativeFields.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeField} params.resource Request body data - * @param {object} [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$Creativefields$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Creativefields$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Creativefields$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Creativefields$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefields$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefields$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativefields$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefields$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefields$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - export interface Params$Resource$Creativefields$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only creative fields that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only creative fields with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativefields$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative Field ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - export interface Params$Resource$Creativefields$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeField; - } - - export class Resource$Creativefieldvalues { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creativeFieldValues.delete - * @desc Deletes an existing creative field value. - * @alias dfareporting.creativeFieldValues.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Creativefieldvalues$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Creativefieldvalues$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Creativefieldvalues$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFieldValues.get - * @desc Gets one creative field value by ID. - * @alias dfareporting.creativeFieldValues.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Creativefieldvalues$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Creativefieldvalues$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Creativefieldvalues$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFieldValues.insert - * @desc Inserts a new creative field value. - * @alias dfareporting.creativeFieldValues.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} params.resource Request body data - * @param {object} [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$Creativefieldvalues$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creativefieldvalues$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creativefieldvalues$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFieldValues.list - * @desc Retrieves a list of creative field values, possibly filtered. This method supports paging. - * @alias dfareporting.creativeFieldValues.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string=} params.ids Select only creative field values with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Creativefieldvalues$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Creativefieldvalues$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Creativefieldvalues$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.creativeFieldValues.patch - * @desc Updates an existing creative field value. This method supports patch semantics. - * @alias dfareporting.creativeFieldValues.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.id Creative Field Value ID - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} params.resource Request body data - * @param {object} [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$Creativefieldvalues$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Creativefieldvalues$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Creativefieldvalues$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeFieldValues.update - * @desc Updates an existing creative field value. - * @alias dfareporting.creativeFieldValues.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.creativeFieldId Creative field ID for this creative field value. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeFieldValue} params.resource Request body data - * @param {object} [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$Creativefieldvalues$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Creativefieldvalues$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Creativefieldvalues$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Creativefieldvalues$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativefieldvalues$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativefieldvalues$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativefieldvalues$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefieldvalues$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativefieldvalues$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - export interface Params$Resource$Creativefieldvalues$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Select only creative field values with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativefieldvalues$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * Creative Field Value ID - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - export interface Params$Resource$Creativefieldvalues$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative field ID for this creative field value. - */ - creativeFieldId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeFieldValue; - } - - export class Resource$Creativegroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creativeGroups.get - * @desc Gets one creative group by ID. - * @alias dfareporting.creativeGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Creativegroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Creativegroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Creativegroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Creativegroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeGroups.insert - * @desc Inserts a new creative group. - * @alias dfareporting.creativeGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} params.resource Request body data - * @param {object} [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$Creativegroups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creativegroups$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creativegroups$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creativegroups$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeGroups.list - * @desc Retrieves a list of creative groups, possibly filtered. This method supports paging. - * @alias dfareporting.creativeGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only creative groups that belong to these advertisers. - * @param {integer=} params.groupNumber Select only creative groups that belong to this subgroup. - * @param {string=} params.ids Select only creative groups with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Creativegroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Creativegroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Creativegroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Creativegroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeGroups.patch - * @desc Updates an existing creative group. This method supports patch semantics. - * @alias dfareporting.creativeGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} params.resource Request body data - * @param {object} [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$Creativegroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Creativegroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Creativegroups$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Creativegroups$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creativeGroups.update - * @desc Updates an existing creative group. - * @alias dfareporting.creativeGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().CreativeGroup} params.resource Request body data - * @param {object} [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$Creativegroups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Creativegroups$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Creativegroups$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Creativegroups$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Creativegroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creativegroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creativeGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creativegroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creativegroups$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - export interface Params$Resource$Creativegroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only creative groups that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only creative groups that belong to this subgroup. - */ - groupNumber?: number; - /** - * Select only creative groups with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Creativegroups$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - export interface Params$Resource$Creativegroups$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreativeGroup; - } - - export class Resource$Creatives { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.creatives.get - * @desc Gets one creative by ID. - * @alias dfareporting.creatives.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Creatives$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Creatives$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Creatives$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Creatives$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/creatives/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creatives.insert - * @desc Inserts a new creative. - * @alias dfareporting.creatives.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} params.resource Request body data - * @param {object} [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$Creatives$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Creatives$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Creatives$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Creatives$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creatives.list - * @desc Retrieves a list of creatives, possibly filtered. This method supports paging. - * @alias dfareporting.creatives.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active creatives. Leave blank to select active and inactive creatives. - * @param {string=} params.advertiserId Select only creatives with this advertiser ID. - * @param {boolean=} params.archived Select only archived creatives. Leave blank to select archived and unarchived creatives. - * @param {string=} params.campaignId Select only creatives with this campaign ID. - * @param {string=} params.companionCreativeIds Select only in-stream video creatives with these companion IDs. - * @param {string=} params.creativeFieldIds Select only creatives with these creative field IDs. - * @param {string=} params.ids Select only creatives with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.renderingIds Select only creatives with these rendering IDs. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". - * @param {string=} params.sizeIds Select only creatives with these size IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.studioCreativeId Select only creatives corresponding to this Studio creative ID. - * @param {string=} params.types Select only creatives with these creative types. - * @param {object} [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$Creatives$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Creatives$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Creatives$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Creatives$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creatives.patch - * @desc Updates an existing creative. This method supports patch semantics. - * @alias dfareporting.creatives.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Creative ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} params.resource Request body data - * @param {object} [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$Creatives$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Creatives$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Creatives$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Creatives$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.creatives.update - * @desc Updates an existing creative. - * @alias dfareporting.creatives.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Creative} params.resource Request body data - * @param {object} [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$Creatives$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Creatives$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Creatives$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Creatives$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Creatives$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Creatives$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Creatives$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - export interface Params$Resource$Creatives$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active creatives. Leave blank to select active and inactive creatives. - */ - active?: boolean; - /** - * Select only creatives with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only archived creatives. Leave blank to select archived and unarchived creatives. - */ - archived?: boolean; - /** - * Select only creatives with this campaign ID. - */ - campaignId?: string; - /** - * Select only in-stream video creatives with these companion IDs. - */ - companionCreativeIds?: string[]; - /** - * Select only creatives with these creative field IDs. - */ - creativeFieldIds?: string[]; - /** - * Select only creatives with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only creatives with these rendering IDs. - */ - renderingIds?: string[]; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". - */ - searchString?: string; - /** - * Select only creatives with these size IDs. - */ - sizeIds?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only creatives corresponding to this Studio creative ID. - */ - studioCreativeId?: string; - /** - * Select only creatives with these creative types. - */ - types?: string[]; - } - export interface Params$Resource$Creatives$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Creative ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - export interface Params$Resource$Creatives$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - - export class Resource$Dimensionvalues { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.dimensionValues.query - * @desc Retrieves list of report dimension values for a list of filters. - * @alias dfareporting.dimensionValues.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA user profile ID. - * @param {().DimensionValueRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - query( - params?: Params$Resource$Dimensionvalues$Query, - options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Dimensionvalues$Query, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Dimensionvalues$Query, - callback: BodyResponseCallback - ): void; - query(callback: BodyResponseCallback): void; - query( - paramsOrCallback?: - | Params$Resource$Dimensionvalues$Query - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Dimensionvalues$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dimensionvalues$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/dimensionvalues/query' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Dimensionvalues$Query - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DimensionValueRequest; - } - - export class Resource$Directorysitecontacts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.directorySiteContacts.get - * @desc Gets one directory site contact by ID. - * @alias dfareporting.directorySiteContacts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Directory site contact ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Directorysitecontacts$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Directorysitecontacts$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Directorysitecontacts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Directorysitecontacts$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Directorysitecontacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysitecontacts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/directorySiteContacts/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.directorySiteContacts.list - * @desc Retrieves a list of directory site contacts, possibly filtered. This method supports paging. - * @alias dfareporting.directorySiteContacts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.directorySiteIds Select only directory site contacts with these directory site IDs. This is a required field. - * @param {string=} params.ids Select only directory site contacts with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Directorysitecontacts$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Directorysitecontacts$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Directorysitecontacts$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Directorysitecontacts$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Directorysitecontacts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysitecontacts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/directorySiteContacts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Directorysitecontacts$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Directory site contact ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Directorysitecontacts$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only directory site contacts with these directory site IDs. This is a required field. - */ - directorySiteIds?: string[]; - /** - * Select only directory site contacts with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Directorysites { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.directorySites.get - * @desc Gets one directory site by ID. - * @alias dfareporting.directorySites.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Directory site ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Directorysites$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Directorysites$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Directorysites$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Directorysites$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Directorysites$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/directorySites/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.directorySites.insert - * @desc Inserts a new directory site. - * @alias dfareporting.directorySites.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().DirectorySite} params.resource Request body data - * @param {object} [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$Directorysites$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Directorysites$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Directorysites$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Directorysites$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Directorysites$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/directorySites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.directorySites.list - * @desc Retrieves a list of directory sites, possibly filtered. This method supports paging. - * @alias dfareporting.directorySites.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsPublisherPaidPlacements Select only directory sites that accept publisher paid placements. This field can be left blank. - * @param {boolean=} params.active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. - * @param {string=} params.countryId Select only directory sites with this country ID. - * @param {string=} params.dfpNetworkCode Select only directory sites with this Ad Manager network code. - * @param {string=} params.ids Select only directory sites with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.parentId Select only directory sites with this parent ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Directorysites$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Directorysites$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Directorysites$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Directorysites$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Directorysites$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysites$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/directorySites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Directorysites$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Directory site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Directorysites$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DirectorySite; - } - export interface Params$Resource$Directorysites$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * This search filter is no longer supported and will have no effect on the results returned. - */ - acceptsInStreamVideoPlacements?: boolean; - /** - * This search filter is no longer supported and will have no effect on the results returned. - */ - acceptsInterstitialPlacements?: boolean; - /** - * Select only directory sites that accept publisher paid placements. This field can be left blank. - */ - acceptsPublisherPaidPlacements?: boolean; - /** - * Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. - */ - active?: boolean; - /** - * Select only directory sites with this country ID. - */ - countryId?: string; - /** - * Select only directory sites with this Ad Manager network code. - */ - dfpNetworkCode?: string; - /** - * Select only directory sites with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only directory sites with this parent ID. - */ - parentId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Dynamictargetingkeys { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.dynamicTargetingKeys.delete - * @desc Deletes an existing dynamic targeting key. - * @alias dfareporting.dynamicTargetingKeys.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. - * @param {string} params.objectId ID of the object of this dynamic targeting key. This is a required field. - * @param {string} params.objectType Type of the object of this dynamic targeting key. This is a required field. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Dynamictargetingkeys$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Dynamictargetingkeys$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Dynamictargetingkeys$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Dynamictargetingkeys$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Dynamictargetingkeys$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'objectId', 'name', 'objectType'], - pathParams: ['objectId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.dynamicTargetingKeys.insert - * @desc Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. - * @alias dfareporting.dynamicTargetingKeys.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().DynamicTargetingKey} params.resource Request body data - * @param {object} [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$Dynamictargetingkeys$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Dynamictargetingkeys$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Dynamictargetingkeys$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Dynamictargetingkeys$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Dynamictargetingkeys$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/dynamicTargetingKeys' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.dynamicTargetingKeys.list - * @desc Retrieves a list of dynamic targeting keys. - * @alias dfareporting.dynamicTargetingKeys.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only dynamic targeting keys whose object has this advertiser ID. - * @param {string=} params.names Select only dynamic targeting keys exactly matching these names. - * @param {string=} params.objectId Select only dynamic targeting keys with this object ID. - * @param {string=} params.objectType Select only dynamic targeting keys with this object type. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Dynamictargetingkeys$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Dynamictargetingkeys$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Dynamictargetingkeys$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Dynamictargetingkeys$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Dynamictargetingkeys$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Dynamictargetingkeys$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/dynamicTargetingKeys' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Dynamictargetingkeys$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. - */ - name?: string; - /** - * ID of the object of this dynamic targeting key. This is a required field. - */ - objectId?: string; - /** - * Type of the object of this dynamic targeting key. This is a required field. - */ - objectType?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Dynamictargetingkeys$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DynamicTargetingKey; - } - export interface Params$Resource$Dynamictargetingkeys$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only dynamic targeting keys whose object has this advertiser ID. - */ - advertiserId?: string; - /** - * Select only dynamic targeting keys exactly matching these names. - */ - names?: string[]; - /** - * Select only dynamic targeting keys with this object ID. - */ - objectId?: string; - /** - * Select only dynamic targeting keys with this object type. - */ - objectType?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Eventtags { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.eventTags.delete - * @desc Deletes an existing event tag. - * @alias dfareporting.eventTags.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Eventtags$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Eventtags$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Eventtags$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Eventtags$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/eventTags/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.get - * @desc Gets one event tag by ID. - * @alias dfareporting.eventTags.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Eventtags$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Eventtags$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Eventtags$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Eventtags$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/eventTags/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.insert - * @desc Inserts a new event tag. - * @alias dfareporting.eventTags.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} params.resource Request body data - * @param {object} [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$Eventtags$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Eventtags$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Eventtags$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Eventtags$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/eventTags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.list - * @desc Retrieves a list of event tags, possibly filtered. - * @alias dfareporting.eventTags.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.adId Select only event tags that belong to this ad. - * @param {string=} params.advertiserId Select only event tags that belong to this advertiser. - * @param {string=} params.campaignId Select only event tags that belong to this campaign. - * @param {boolean=} params.definitionsOnly Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. - * @param {boolean=} params.enabled Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. - * @param {string=} params.eventTagTypes Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. - * @param {string=} params.ids Select only event tags with these IDs. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Eventtags$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Eventtags$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Eventtags$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Eventtags$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/eventTags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.patch - * @desc Updates an existing event tag. This method supports patch semantics. - * @alias dfareporting.eventTags.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Event tag ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} params.resource Request body data - * @param {object} [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$Eventtags$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Eventtags$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Eventtags$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Eventtags$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/eventTags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.eventTags.update - * @desc Updates an existing event tag. - * @alias dfareporting.eventTags.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().EventTag} params.resource Request body data - * @param {object} [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$Eventtags$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Eventtags$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Eventtags$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Eventtags$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Eventtags$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/eventTags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Eventtags$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Eventtags$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Eventtags$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - export interface Params$Resource$Eventtags$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only event tags that belong to this ad. - */ - adId?: string; - /** - * Select only event tags that belong to this advertiser. - */ - advertiserId?: string; - /** - * Select only event tags that belong to this campaign. - */ - campaignId?: string; - /** - * Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. - */ - definitionsOnly?: boolean; - /** - * Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. - */ - enabled?: boolean; - /** - * Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. - */ - eventTagTypes?: string[]; - /** - * Select only event tags with these IDs. - */ - ids?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Eventtags$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Event tag ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - export interface Params$Resource$Eventtags$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EventTag; - } - - export class Resource$Files { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.files.get - * @desc Retrieves a report file by its report ID and file ID. This method supports media download. - * @alias dfareporting.files.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the report file. - * @param {string} params.reportId The ID of the report. - * @param {object} [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$Files$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Files$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Files$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Files$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Files$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/reports/{reportId}/files/{fileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['reportId', 'fileId'], - pathParams: ['fileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.files.list - * @desc Lists files for a user profile. - * @alias dfareporting.files.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA profile ID. - * @param {string=} params.scope The scope that defines which results are returned. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Files$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Files$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Files$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Files$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Files$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Files$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/files' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Files$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the report file. - */ - fileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Files$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The scope that defines which results are returned. - */ - scope?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Floodlightactivities { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.floodlightActivities.delete - * @desc Deletes an existing floodlight activity. - * @alias dfareporting.floodlightActivities.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Floodlightactivities$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Floodlightactivities$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Floodlightactivities$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivities/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivities.generatetag - * @desc Generates a tag for a floodlight activity. - * @alias dfareporting.floodlightActivities.generatetag - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.floodlightActivityId Floodlight activity ID for which we want to generate a tag. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - generatetag( - params?: Params$Resource$Floodlightactivities$Generatetag, - options?: MethodOptions - ): GaxiosPromise; - generatetag( - params: Params$Resource$Floodlightactivities$Generatetag, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse - > - ): void; - generatetag( - params: Params$Resource$Floodlightactivities$Generatetag, - callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse - > - ): void; - generatetag( - callback: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse - > - ): void; - generatetag( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Generatetag - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$FloodlightActivitiesGenerateTagResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Generatetag; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Generatetag; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivities/generatetag' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.floodlightActivities.get - * @desc Gets one floodlight activity by ID. - * @alias dfareporting.floodlightActivities.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Floodlightactivities$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Floodlightactivities$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Floodlightactivities$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivities/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivities.insert - * @desc Inserts a new floodlight activity. - * @alias dfareporting.floodlightActivities.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} params.resource Request body data - * @param {object} [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$Floodlightactivities$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Floodlightactivities$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Floodlightactivities$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivities.list - * @desc Retrieves a list of floodlight activities, possibly filtered. This method supports paging. - * @alias dfareporting.floodlightActivities.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs. - * @param {string=} params.floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name. - * @param {string=} params.floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string. - * @param {string=} params.floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type. - * @param {string=} params.floodlightConfigurationId Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.ids Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.tagString Select only floodlight activities with the specified tag string. - * @param {object} [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$Floodlightactivities$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Floodlightactivities$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Floodlightactivities$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.floodlightActivities.patch - * @desc Updates an existing floodlight activity. This method supports patch semantics. - * @alias dfareporting.floodlightActivities.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} params.resource Request body data - * @param {object} [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$Floodlightactivities$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Floodlightactivities$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Floodlightactivities$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivities.update - * @desc Updates an existing floodlight activity. - * @alias dfareporting.floodlightActivities.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivity} params.resource Request body data - * @param {object} [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$Floodlightactivities$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Floodlightactivities$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Floodlightactivities$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Floodlightactivities$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivities$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivities$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivities' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightactivities$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Generatetag - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity ID for which we want to generate a tag. - */ - floodlightActivityId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivities$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - export interface Params$Resource$Floodlightactivities$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - */ - advertiserId?: string; - /** - * Select only floodlight activities with the specified floodlight activity group IDs. - */ - floodlightActivityGroupIds?: string[]; - /** - * Select only floodlight activities with the specified floodlight activity group name. - */ - floodlightActivityGroupName?: string; - /** - * Select only floodlight activities with the specified floodlight activity group tag string. - */ - floodlightActivityGroupTagString?: string; - /** - * Select only floodlight activities with the specified floodlight activity group type. - */ - floodlightActivityGroupType?: string; - /** - * Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - */ - floodlightConfigurationId?: string; - /** - * Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only floodlight activities with the specified tag string. - */ - tagString?: string; - } - export interface Params$Resource$Floodlightactivities$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - export interface Params$Resource$Floodlightactivities$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivity; - } - - export class Resource$Floodlightactivitygroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.floodlightActivityGroups.get - * @desc Gets one floodlight activity group by ID. - * @alias dfareporting.floodlightActivityGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity Group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Floodlightactivitygroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Floodlightactivitygroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Floodlightactivitygroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivityGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivityGroups.insert - * @desc Inserts a new floodlight activity group. - * @alias dfareporting.floodlightActivityGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} params.resource Request body data - * @param {object} [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$Floodlightactivitygroups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Floodlightactivitygroups$Insert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Floodlightactivitygroups$Insert, - callback: BodyResponseCallback - ): void; - insert( - callback: BodyResponseCallback - ): void; - insert( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivityGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivityGroups.list - * @desc Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. - * @alias dfareporting.floodlightActivityGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - * @param {string=} params.floodlightConfigurationId Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. - * @param {string=} params.ids Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.type Select only floodlight activity groups with the specified floodlight activity group 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 - */ - list( - params?: Params$Resource$Floodlightactivitygroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Floodlightactivitygroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$FloodlightActivityGroupsListResponse - > - ): void; - list( - params: Params$Resource$Floodlightactivitygroups$List, - callback: BodyResponseCallback< - Schema$FloodlightActivityGroupsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$FloodlightActivityGroupsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$FloodlightActivityGroupsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivityGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.floodlightActivityGroups.patch - * @desc Updates an existing floodlight activity group. This method supports patch semantics. - * @alias dfareporting.floodlightActivityGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight activity Group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} params.resource Request body data - * @param {object} [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$Floodlightactivitygroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Floodlightactivitygroups$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Floodlightactivitygroups$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivityGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightActivityGroups.update - * @desc Updates an existing floodlight activity group. - * @alias dfareporting.floodlightActivityGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightActivityGroup} params.resource Request body data - * @param {object} [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$Floodlightactivitygroups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Floodlightactivitygroups$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Floodlightactivitygroups$Update, - callback: BodyResponseCallback - ): void; - update( - callback: BodyResponseCallback - ): void; - update( - paramsOrCallback?: - | Params$Resource$Floodlightactivitygroups$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightactivitygroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightactivitygroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightActivityGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightactivitygroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity Group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightactivitygroups$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - export interface Params$Resource$Floodlightactivitygroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - */ - advertiserId?: string; - /** - * Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. - */ - floodlightConfigurationId?: string; - /** - * Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only floodlight activity groups with the specified floodlight activity group type. - */ - type?: string; - } - export interface Params$Resource$Floodlightactivitygroups$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight activity Group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - export interface Params$Resource$Floodlightactivitygroups$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightActivityGroup; - } - - export class Resource$Floodlightconfigurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.floodlightConfigurations.get - * @desc Gets one floodlight configuration by ID. - * @alias dfareporting.floodlightConfigurations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight configuration ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Floodlightconfigurations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Floodlightconfigurations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Floodlightconfigurations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Floodlightconfigurations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightconfigurations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightConfigurations/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightConfigurations.list - * @desc Retrieves a list of floodlight configurations, possibly filtered. - * @alias dfareporting.floodlightConfigurations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Floodlightconfigurations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Floodlightconfigurations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$FloodlightConfigurationsListResponse - > - ): void; - list( - params: Params$Resource$Floodlightconfigurations$List, - callback: BodyResponseCallback< - Schema$FloodlightConfigurationsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$FloodlightConfigurationsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Floodlightconfigurations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$FloodlightConfigurationsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightconfigurations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightConfigurations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.floodlightConfigurations.patch - * @desc Updates an existing floodlight configuration. This method supports patch semantics. - * @alias dfareporting.floodlightConfigurations.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Floodlight configuration ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightConfiguration} params.resource Request body data - * @param {object} [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$Floodlightconfigurations$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Floodlightconfigurations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Floodlightconfigurations$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Floodlightconfigurations$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightconfigurations$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightConfigurations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.floodlightConfigurations.update - * @desc Updates an existing floodlight configuration. - * @alias dfareporting.floodlightConfigurations.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().FloodlightConfiguration} params.resource Request body data - * @param {object} [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$Floodlightconfigurations$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Floodlightconfigurations$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Floodlightconfigurations$Update, - callback: BodyResponseCallback - ): void; - update( - callback: BodyResponseCallback - ): void; - update( - paramsOrCallback?: - | Params$Resource$Floodlightconfigurations$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Floodlightconfigurations$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Floodlightconfigurations$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/floodlightConfigurations' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Floodlightconfigurations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight configuration ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightconfigurations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. - */ - ids?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Floodlightconfigurations$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Floodlight configuration ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightConfiguration; - } - export interface Params$Resource$Floodlightconfigurations$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$FloodlightConfiguration; - } - - export class Resource$Inventoryitems { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.inventoryItems.get - * @desc Gets one inventory item by ID. - * @alias dfareporting.inventoryItems.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Inventory item ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {object} [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$Inventoryitems$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Inventoryitems$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Inventoryitems$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Inventoryitems$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Inventoryitems$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Inventoryitems$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.inventoryItems.list - * @desc Retrieves a list of inventory items, possibly filtered. This method supports paging. - * @alias dfareporting.inventoryItems.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only inventory items with these IDs. - * @param {boolean=} params.inPlan Select only inventory items that are in plan. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.orderId Select only inventory items that belong to specified orders. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {string=} params.siteId Select only inventory items that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.type Select only inventory items with this 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 - */ - list( - params?: Params$Resource$Inventoryitems$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Inventoryitems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Inventoryitems$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Inventoryitems$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Inventoryitems$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Inventoryitems$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/projects/{projectId}/inventoryItems' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Inventoryitems$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Inventory item ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - } - export interface Params$Resource$Inventoryitems$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only inventory items with these IDs. - */ - ids?: string[]; - /** - * Select only inventory items that are in plan. - */ - inPlan?: boolean; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only inventory items that belong to specified orders. - */ - orderId?: string[]; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - /** - * Select only inventory items that are associated with these sites. - */ - siteId?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only inventory items with this type. - */ - type?: string; - } - - export class Resource$Languages { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.languages.list - * @desc Retrieves a list of languages. - * @alias dfareporting.languages.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Languages$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Languages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Languages$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Languages$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Languages$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Languages$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/languages' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Languages$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Metros { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.metros.list - * @desc Retrieves a list of metros. - * @alias dfareporting.metros.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Metros$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Metros$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Metros$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Metros$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Metros$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Metros$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/metros' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Metros$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Mobileapps { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.mobileApps.get - * @desc Gets one mobile app by ID. - * @alias dfareporting.mobileApps.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Mobile app ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Mobileapps$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Mobileapps$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Mobileapps$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Mobileapps$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobileapps$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/mobileApps/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.mobileApps.list - * @desc Retrieves list of available mobile apps. - * @alias dfareporting.mobileApps.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.directories Select only apps from these directories. - * @param {string=} params.ids Select only apps with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". - * @param {object} [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$Mobileapps$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Mobileapps$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Mobileapps$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Mobileapps$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobileapps$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/mobileApps' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Mobileapps$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Mobile app ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Mobileapps$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only apps from these directories. - */ - directories?: string[]; - /** - * Select only apps with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". - */ - searchString?: string; - } - - export class Resource$Mobilecarriers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.mobileCarriers.get - * @desc Gets one mobile carrier by ID. - * @alias dfareporting.mobileCarriers.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Mobile carrier ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Mobilecarriers$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Mobilecarriers$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Mobilecarriers$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Mobilecarriers$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Mobilecarriers$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobilecarriers$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/mobileCarriers/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.mobileCarriers.list - * @desc Retrieves a list of mobile carriers. - * @alias dfareporting.mobileCarriers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Mobilecarriers$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Mobilecarriers$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Mobilecarriers$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Mobilecarriers$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Mobilecarriers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Mobilecarriers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/mobileCarriers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Mobilecarriers$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Mobile carrier ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Mobilecarriers$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Operatingsystems { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.operatingSystems.get - * @desc Gets one operating system by DART ID. - * @alias dfareporting.operatingSystems.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.dartId Operating system DART ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Operatingsystems$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Operatingsystems$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Operatingsystems$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Operatingsystems$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Operatingsystems$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystems$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/operatingSystems/{dartId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'dartId'], - pathParams: ['dartId', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.operatingSystems.list - * @desc Retrieves a list of operating systems. - * @alias dfareporting.operatingSystems.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Operatingsystems$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Operatingsystems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Operatingsystems$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Operatingsystems$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Operatingsystems$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystems$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/operatingSystems' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Operatingsystems$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Operating system DART ID. - */ - dartId?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Operatingsystems$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Operatingsystemversions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.operatingSystemVersions.get - * @desc Gets one operating system version by ID. - * @alias dfareporting.operatingSystemVersions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Operating system version ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Operatingsystemversions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Operatingsystemversions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Operatingsystemversions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Operatingsystemversions$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Operatingsystemversions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystemversions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/operatingSystemVersions/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.operatingSystemVersions.list - * @desc Retrieves a list of operating system versions. - * @alias dfareporting.operatingSystemVersions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Operatingsystemversions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Operatingsystemversions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Operatingsystemversions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Operatingsystemversions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$OperatingSystemVersionsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Operatingsystemversions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operatingsystemversions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/operatingSystemVersions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Operatingsystemversions$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Operating system version ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Operatingsystemversions$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Orderdocuments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.orderDocuments.get - * @desc Gets one order document by ID. - * @alias dfareporting.orderDocuments.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Order document ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {object} [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$Orderdocuments$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Orderdocuments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Orderdocuments$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Orderdocuments$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Orderdocuments$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderdocuments$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.orderDocuments.list - * @desc Retrieves a list of order documents, possibly filtered. This method supports paging. - * @alias dfareporting.orderDocuments.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.approved Select only order documents that have been approved by at least one user. - * @param {string=} params.ids Select only order documents with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.orderId Select only order documents for specified orders. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for order documents. - * @param {string=} params.searchString Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". - * @param {string=} params.siteId Select only order documents that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Orderdocuments$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Orderdocuments$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Orderdocuments$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Orderdocuments$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Orderdocuments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orderdocuments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/projects/{projectId}/orderDocuments' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Orderdocuments$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Order document ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - } - export interface Params$Resource$Orderdocuments$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only order documents that have been approved by at least one user. - */ - approved?: boolean; - /** - * Select only order documents with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only order documents for specified orders. - */ - orderId?: string[]; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for order documents. - */ - projectId?: string; - /** - * Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". - */ - searchString?: string; - /** - * Select only order documents that are associated with these sites. - */ - siteId?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Orders { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.orders.get - * @desc Gets one order by ID. - * @alias dfareporting.orders.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Order ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for orders. - * @param {object} [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$Orders$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Orders$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Orders$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Orders$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/projects/{projectId}/orders/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.orders.list - * @desc Retrieves a list of orders, possibly filtered. This method supports paging. - * @alias dfareporting.orders.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only orders with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.projectId Project ID for orders. - * @param {string=} params.searchString Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". - * @param {string=} params.siteId Select only orders that are associated with these site IDs. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Orders$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Orders$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Orders$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Orders$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Orders$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Orders$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/projects/{projectId}/orders' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Orders$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Order ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for orders. - */ - projectId?: string; - } - export interface Params$Resource$Orders$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only orders with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Project ID for orders. - */ - projectId?: string; - /** - * Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". - */ - searchString?: string; - /** - * Select only orders that are associated with these site IDs. - */ - siteId?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Placementgroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.placementGroups.get - * @desc Gets one placement group by ID. - * @alias dfareporting.placementGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Placementgroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Placementgroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Placementgroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Placementgroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementGroups.insert - * @desc Inserts a new placement group. - * @alias dfareporting.placementGroups.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} params.resource Request body data - * @param {object} [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$Placementgroups$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Placementgroups$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Placementgroups$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Placementgroups$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementGroups.list - * @desc Retrieves a list of placement groups, possibly filtered. This method supports paging. - * @alias dfareporting.placementGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only placement groups that belong to these advertisers. - * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. - * @param {string=} params.campaignIds Select only placement groups that belong to these campaigns. - * @param {string=} params.contentCategoryIds Select only placement groups that are associated with these content categories. - * @param {string=} params.directorySiteIds Select only placement groups that are associated with these directory sites. - * @param {string=} params.ids Select only placement groups with these IDs. - * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. - * @param {string=} params.placementStrategyIds Select only placement groups that are associated with these placement strategies. - * @param {string=} params.pricingTypes Select only placement groups with these pricing types. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". - * @param {string=} params.siteIds Select only placement groups that are associated with these sites. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Placementgroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Placementgroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Placementgroups$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Placementgroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementGroups.patch - * @desc Updates an existing placement group. This method supports patch semantics. - * @alias dfareporting.placementGroups.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} params.resource Request body data - * @param {object} [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$Placementgroups$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Placementgroups$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Placementgroups$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Placementgroups$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementGroups.update - * @desc Updates an existing placement group. - * @alias dfareporting.placementGroups.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementGroup} params.resource Request body data - * @param {object} [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$Placementgroups$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Placementgroups$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Placementgroups$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Placementgroups$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementgroups$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementgroups$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placementgroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementgroups$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - export interface Params$Resource$Placementgroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only placement groups that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only archived placements. Don't set this field to select both archived and non-archived placements. - */ - archived?: boolean; - /** - * Select only placement groups that belong to these campaigns. - */ - campaignIds?: string[]; - /** - * Select only placement groups that are associated with these content categories. - */ - contentCategoryIds?: string[]; - /** - * Select only placement groups that are associated with these directory sites. - */ - directorySiteIds?: string[]; - /** - * Select only placement groups with these IDs. - */ - ids?: string[]; - /** - * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - */ - maxEndDate?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - */ - maxStartDate?: string; - /** - * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - */ - minEndDate?: string; - /** - * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - */ - minStartDate?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. - */ - placementGroupType?: string; - /** - * Select only placement groups that are associated with these placement strategies. - */ - placementStrategyIds?: string[]; - /** - * Select only placement groups with these pricing types. - */ - pricingTypes?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". - */ - searchString?: string; - /** - * Select only placement groups that are associated with these sites. - */ - siteIds?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placementgroups$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - export interface Params$Resource$Placementgroups$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementGroup; - } - - export class Resource$Placements { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.placements.generatetags - * @desc Generates tags for a placement. - * @alias dfareporting.placements.generatetags - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.campaignId Generate placements belonging to this campaign. This is a required field. - * @param {string=} params.placementIds Generate tags for these placements. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.tagFormats Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - generatetags( - params?: Params$Resource$Placements$Generatetags, - options?: MethodOptions - ): GaxiosPromise; - generatetags( - params: Params$Resource$Placements$Generatetags, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generatetags( - params: Params$Resource$Placements$Generatetags, - callback: BodyResponseCallback - ): void; - generatetags( - callback: BodyResponseCallback - ): void; - generatetags( - paramsOrCallback?: - | Params$Resource$Placements$Generatetags - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placements$Generatetags; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Generatetags; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placements/generatetags' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.placements.get - * @desc Gets one placement by ID. - * @alias dfareporting.placements.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Placements$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Placements$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Placements$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Placements$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placements/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placements.insert - * @desc Inserts a new placement. - * @alias dfareporting.placements.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} params.resource Request body data - * @param {object} [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$Placements$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Placements$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Placements$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Placements$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placements$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/placements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placements.list - * @desc Retrieves a list of placements, possibly filtered. This method supports paging. - * @alias dfareporting.placements.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only placements that belong to these advertisers. - * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. - * @param {string=} params.campaignIds Select only placements that belong to these campaigns. - * @param {string=} params.compatibilities Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. - * @param {string=} params.contentCategoryIds Select only placements that are associated with these content categories. - * @param {string=} params.directorySiteIds Select only placements that are associated with these directory sites. - * @param {string=} params.groupIds Select only placements that belong to these placement groups. - * @param {string=} params.ids Select only placements with these IDs. - * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string=} params.paymentSource Select only placements with this payment source. - * @param {string=} params.placementStrategyIds Select only placements that are associated with these placement strategies. - * @param {string=} params.pricingTypes Select only placements with these pricing types. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". - * @param {string=} params.siteIds Select only placements that are associated with these sites. - * @param {string=} params.sizeIds Select only placements that are associated with these sizes. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Placements$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Placements$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Placements$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Placements$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/placements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placements.patch - * @desc Updates an existing placement. This method supports patch semantics. - * @alias dfareporting.placements.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} params.resource Request body data - * @param {object} [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$Placements$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Placements$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Placements$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Placements$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Placements$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/placements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placements.update - * @desc Updates an existing placement. - * @alias dfareporting.placements.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Placement} params.resource Request body data - * @param {object} [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$Placements$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Placements$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Placements$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Placements$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placements$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placements$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/placements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placements$Generatetags - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Generate placements belonging to this campaign. This is a required field. - */ - campaignId?: string; - /** - * Generate tags for these placements. - */ - placementIds?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. - */ - tagFormats?: string[]; - } - export interface Params$Resource$Placements$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placements$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - export interface Params$Resource$Placements$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only placements that belong to these advertisers. - */ - advertiserIds?: string[]; - /** - * Select only archived placements. Don't set this field to select both archived and non-archived placements. - */ - archived?: boolean; - /** - * Select only placements that belong to these campaigns. - */ - campaignIds?: string[]; - /** - * Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. - */ - compatibilities?: string[]; - /** - * Select only placements that are associated with these content categories. - */ - contentCategoryIds?: string[]; - /** - * Select only placements that are associated with these directory sites. - */ - directorySiteIds?: string[]; - /** - * Select only placements that belong to these placement groups. - */ - groupIds?: string[]; - /** - * Select only placements with these IDs. - */ - ids?: string[]; - /** - * Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". - */ - maxEndDate?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". - */ - maxStartDate?: string; - /** - * Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". - */ - minEndDate?: string; - /** - * Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". - */ - minStartDate?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * Select only placements with this payment source. - */ - paymentSource?: string; - /** - * Select only placements that are associated with these placement strategies. - */ - placementStrategyIds?: string[]; - /** - * Select only placements with these pricing types. - */ - pricingTypes?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". - */ - searchString?: string; - /** - * Select only placements that are associated with these sites. - */ - siteIds?: string[]; - /** - * Select only placements that are associated with these sizes. - */ - sizeIds?: string[]; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placements$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - export interface Params$Resource$Placements$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Placement; - } - - export class Resource$Placementstrategies { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.placementStrategies.delete - * @desc Deletes an existing placement strategy. - * @alias dfareporting.placementStrategies.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Placementstrategies$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Placementstrategies$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Placementstrategies$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementStrategies/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementStrategies.get - * @desc Gets one placement strategy by ID. - * @alias dfareporting.placementStrategies.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Placementstrategies$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Placementstrategies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Placementstrategies$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementStrategies/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementStrategies.insert - * @desc Inserts a new placement strategy. - * @alias dfareporting.placementStrategies.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} params.resource Request body data - * @param {object} [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$Placementstrategies$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Placementstrategies$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Placementstrategies$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementStrategies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementStrategies.list - * @desc Retrieves a list of placement strategies, possibly filtered. This method supports paging. - * @alias dfareporting.placementStrategies.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only placement strategies with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Placementstrategies$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Placementstrategies$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Placementstrategies$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Placementstrategies$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementStrategies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.placementStrategies.patch - * @desc Updates an existing placement strategy. This method supports patch semantics. - * @alias dfareporting.placementStrategies.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Placement strategy ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} params.resource Request body data - * @param {object} [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$Placementstrategies$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Placementstrategies$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Placementstrategies$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementStrategies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.placementStrategies.update - * @desc Updates an existing placement strategy. - * @alias dfareporting.placementStrategies.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().PlacementStrategy} params.resource Request body data - * @param {object} [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$Placementstrategies$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Placementstrategies$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Placementstrategies$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Placementstrategies$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Placementstrategies$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Placementstrategies$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/placementStrategies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Placementstrategies$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementstrategies$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Placementstrategies$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - export interface Params$Resource$Placementstrategies$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only placement strategies with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Placementstrategies$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Placement strategy ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - export interface Params$Resource$Placementstrategies$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PlacementStrategy; - } - - export class Resource$Platformtypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.platformTypes.get - * @desc Gets one platform type by ID. - * @alias dfareporting.platformTypes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Platform type ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Platformtypes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Platformtypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Platformtypes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Platformtypes$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Platformtypes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Platformtypes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/platformTypes/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.platformTypes.list - * @desc Retrieves a list of platform types. - * @alias dfareporting.platformTypes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Platformtypes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Platformtypes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Platformtypes$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Platformtypes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Platformtypes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Platformtypes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/platformTypes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Platformtypes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Platform type ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Platformtypes$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Postalcodes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.postalCodes.get - * @desc Gets one postal code by ID. - * @alias dfareporting.postalCodes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.code Postal code ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Postalcodes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Postalcodes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Postalcodes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Postalcodes$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Postalcodes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/postalCodes/{code}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'code'], - pathParams: ['code', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.postalCodes.list - * @desc Retrieves a list of postal codes. - * @alias dfareporting.postalCodes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Postalcodes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Postalcodes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Postalcodes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Postalcodes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Postalcodes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/postalCodes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Postalcodes$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Postal code ID. - */ - code?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Postalcodes$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Projects { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.projects.get - * @desc Gets one project by ID. - * @alias dfareporting.projects.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Project ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/projects/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.projects.list - * @desc Retrieves a list of projects, possibly filtered. This method supports paging. - * @alias dfareporting.projects.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserIds Select only projects with these advertiser IDs. - * @param {string=} params.ids Select only projects with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/projects' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Project ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Projects$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only projects with these advertiser IDs. - */ - advertiserIds?: string[]; - /** - * Select only projects with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Regions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.regions.list - * @desc Retrieves a list of regions. - * @alias dfareporting.regions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Regions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regions$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regions$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Regions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Regions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/regions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Regions$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Remarketinglists { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.remarketingLists.get - * @desc Gets one remarketing list by ID. - * @alias dfareporting.remarketingLists.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Remarketinglists$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Remarketinglists$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Remarketinglists$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Remarketinglists$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/remarketingLists/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingLists.insert - * @desc Inserts a new remarketing list. - * @alias dfareporting.remarketingLists.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} params.resource Request body data - * @param {object} [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$Remarketinglists$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Remarketinglists$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Remarketinglists$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Remarketinglists$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/remarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingLists.list - * @desc Retrieves a list of remarketing lists, possibly filtered. This method supports paging. - * @alias dfareporting.remarketingLists.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active or only inactive remarketing lists. - * @param {string} params.advertiserId Select only remarketing lists owned by this advertiser. - * @param {string=} params.floodlightActivityId Select only remarketing lists that have this floodlight activity ID. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Remarketinglists$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Remarketinglists$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Remarketinglists$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Remarketinglists$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/remarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.remarketingLists.patch - * @desc Updates an existing remarketing list. This method supports patch semantics. - * @alias dfareporting.remarketingLists.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} params.resource Request body data - * @param {object} [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$Remarketinglists$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Remarketinglists$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Remarketinglists$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Remarketinglists$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/remarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingLists.update - * @desc Updates an existing remarketing list. - * @alias dfareporting.remarketingLists.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingList} params.resource Request body data - * @param {object} [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$Remarketinglists$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Remarketinglists$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Remarketinglists$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Remarketinglists$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglists$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglists$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/remarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Remarketinglists$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Remarketinglists$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - export interface Params$Resource$Remarketinglists$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active or only inactive remarketing lists. - */ - active?: boolean; - /** - * Select only remarketing lists owned by this advertiser. - */ - advertiserId?: string; - /** - * Select only remarketing lists that have this floodlight activity ID. - */ - floodlightActivityId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - */ - name?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Remarketinglists$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - export interface Params$Resource$Remarketinglists$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingList; - } - - export class Resource$Remarketinglistshares { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.remarketingListShares.get - * @desc Gets one remarketing list share by remarketing list ID. - * @alias dfareporting.remarketingListShares.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.remarketingListId Remarketing list 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$Remarketinglistshares$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Remarketinglistshares$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Remarketinglistshares$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Remarketinglistshares$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglistshares$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/remarketingListShares/{remarketingListId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'remarketingListId'], - pathParams: ['profileId', 'remarketingListId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingListShares.patch - * @desc Updates an existing remarketing list share. This method supports patch semantics. - * @alias dfareporting.remarketingListShares.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {string} params.remarketingListId Remarketing list ID. - * @param {().RemarketingListShare} params.resource Request body data - * @param {object} [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$Remarketinglistshares$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Remarketinglistshares$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Remarketinglistshares$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Remarketinglistshares$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglistshares$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/remarketingListShares' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'remarketingListId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.remarketingListShares.update - * @desc Updates an existing remarketing list share. - * @alias dfareporting.remarketingListShares.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().RemarketingListShare} params.resource Request body data - * @param {object} [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$Remarketinglistshares$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Remarketinglistshares$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Remarketinglistshares$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Remarketinglistshares$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Remarketinglistshares$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Remarketinglistshares$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/remarketingListShares' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Remarketinglistshares$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Remarketing list ID. - */ - remarketingListId?: string; - } - export interface Params$Resource$Remarketinglistshares$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Remarketing list ID. - */ - remarketingListId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingListShare; - } - export interface Params$Resource$Remarketinglistshares$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingListShare; - } - - export class Resource$Reports { - context: APIRequestContext; - compatibleFields: Resource$Reports$Compatiblefields; - files: Resource$Reports$Files; - constructor(context: APIRequestContext) { - this.context = context; - this.compatibleFields = new Resource$Reports$Compatiblefields( - this.context - ); - this.files = new Resource$Reports$Files(this.context); - } - - /** - * dfareporting.reports.delete - * @desc Deletes a report by its ID. - * @alias dfareporting.reports.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {object} [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$Reports$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Reports$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Reports$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Reports$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/reports/{reportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.get - * @desc Retrieves a report by its ID. - * @alias dfareporting.reports.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {object} [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$Reports$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Reports$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reports$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Reports$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/reports/{reportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.insert - * @desc Creates a report. - * @alias dfareporting.reports.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {().Report} params.resource Request body data - * @param {object} [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$Reports$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Reports$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Reports$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Reports$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/reports' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.list - * @desc Retrieves list of reports. - * @alias dfareporting.reports.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA user profile ID. - * @param {string=} params.scope The scope that defines which results are returned. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Reports$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Reports$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reports$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Reports$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/reports' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.patch - * @desc Updates a report. This method supports patch semantics. - * @alias dfareporting.reports.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {().Report} params.resource Request body data - * @param {object} [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$Reports$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Reports$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Reports$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Reports$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/reports/{reportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.run - * @desc Runs a report. - * @alias dfareporting.reports.run - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the report. - * @param {boolean=} params.synchronous If set and true, tries to run the report synchronously. - * @param {object} [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$Reports$Run, - options?: MethodOptions - ): GaxiosPromise; - run( - params: Params$Resource$Reports$Run, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - run( - params: Params$Resource$Reports$Run, - callback: BodyResponseCallback - ): void; - run(callback: BodyResponseCallback): void; - run( - paramsOrCallback?: - | Params$Resource$Reports$Run - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Run; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Run; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/reports/{reportId}/run' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.update - * @desc Updates a report. - * @alias dfareporting.reports.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {string} params.reportId The ID of the report. - * @param {().Report} params.resource Request body data - * @param {object} [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$Reports$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Reports$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Reports$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Reports$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Reports$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/reports/{reportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - export interface Params$Resource$Reports$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The scope that defines which results are returned. - */ - scope?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Reports$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - export interface Params$Resource$Reports$Run extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - /** - * If set and true, tries to run the report synchronously. - */ - synchronous?: boolean; - } - export interface Params$Resource$Reports$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - - export class Resource$Reports$Compatiblefields { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.reports.compatibleFields.query - * @desc Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. - * @alias dfareporting.reports.compatibleFields.query - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The DFA user profile ID. - * @param {().Report} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - query( - params?: Params$Resource$Reports$Compatiblefields$Query, - options?: MethodOptions - ): GaxiosPromise; - query( - params: Params$Resource$Reports$Compatiblefields$Query, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Reports$Compatiblefields$Query, - callback: BodyResponseCallback - ): void; - query(callback: BodyResponseCallback): void; - query( - paramsOrCallback?: - | Params$Resource$Reports$Compatiblefields$Query - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Reports$Compatiblefields$Query; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Compatiblefields$Query; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/reports/compatiblefields/query' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Compatiblefields$Query - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The DFA user profile ID. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Report; - } - - export class Resource$Reports$Files { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.reports.files.get - * @desc Retrieves a report file. This method supports media download. - * @alias dfareporting.reports.files.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.fileId The ID of the report file. - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the report. - * @param {object} [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$Reports$Files$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Reports$Files$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reports$Files$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Reports$Files$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Reports$Files$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Files$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/reports/{reportId}/files/{fileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId', 'fileId'], - pathParams: ['fileId', 'profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.reports.files.list - * @desc Lists files for a report. - * @alias dfareporting.reports.files.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken The value of the nextToken from the previous result page. - * @param {string} params.profileId The DFA profile ID. - * @param {string} params.reportId The ID of the parent report. - * @param {string=} params.sortField The field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Reports$Files$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Reports$Files$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reports$Files$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Reports$Files$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Reports$Files$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Reports$Files$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/reports/{reportId}/files' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Reports$Files$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the report file. - */ - fileId?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the report. - */ - reportId?: string; - } - export interface Params$Resource$Reports$Files$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * The value of the nextToken from the previous result page. - */ - pageToken?: string; - /** - * The DFA profile ID. - */ - profileId?: string; - /** - * The ID of the parent report. - */ - reportId?: string; - /** - * The field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Sites { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.sites.get - * @desc Gets one site by ID. - * @alias dfareporting.sites.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Site ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Sites$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Sites$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Sites$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Sites$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/sites/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sites.insert - * @desc Inserts a new site. - * @alias dfareporting.sites.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} params.resource Request body data - * @param {object} [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$Sites$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Sites$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Sites$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Sites$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sites.list - * @desc Retrieves a list of sites, possibly filtered. This method supports paging. - * @alias dfareporting.sites.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. - * @param {boolean=} params.acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements. - * @param {boolean=} params.adWordsSite Select only AdWords sites. - * @param {boolean=} params.approved Select only approved sites. - * @param {string=} params.campaignIds Select only sites with these campaign IDs. - * @param {string=} params.directorySiteIds Select only sites with these directory site IDs. - * @param {string=} params.ids Select only sites with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only sites with this subaccount ID. - * @param {boolean=} params.unmappedSite Select only sites that have not been mapped to a directory site. - * @param {object} [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$Sites$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Sites$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Sites$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Sites$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sites.patch - * @desc Updates an existing site. This method supports patch semantics. - * @alias dfareporting.sites.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Site ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} params.resource Request body data - * @param {object} [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$Sites$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Sites$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Sites$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Sites$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sites.update - * @desc Updates an existing site. - * @alias dfareporting.sites.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Site} params.resource Request body data - * @param {object} [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$Sites$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Sites$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Sites$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Sites$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sites$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sites$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Sites$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Sites$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - export interface Params$Resource$Sites$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * This search filter is no longer supported and will have no effect on the results returned. - */ - acceptsInStreamVideoPlacements?: boolean; - /** - * This search filter is no longer supported and will have no effect on the results returned. - */ - acceptsInterstitialPlacements?: boolean; - /** - * Select only sites that accept publisher paid placements. - */ - acceptsPublisherPaidPlacements?: boolean; - /** - * Select only AdWords sites. - */ - adWordsSite?: boolean; - /** - * Select only approved sites. - */ - approved?: boolean; - /** - * Select only sites with these campaign IDs. - */ - campaignIds?: string[]; - /** - * Select only sites with these directory site IDs. - */ - directorySiteIds?: string[]; - /** - * Select only sites with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only sites with this subaccount ID. - */ - subaccountId?: string; - /** - * Select only sites that have not been mapped to a directory site. - */ - unmappedSite?: boolean; - } - export interface Params$Resource$Sites$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Site ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - export interface Params$Resource$Sites$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - - export class Resource$Sizes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.sizes.get - * @desc Gets one size by ID. - * @alias dfareporting.sizes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Size ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Sizes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Sizes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Sizes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Sizes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/sizes/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sizes.insert - * @desc Inserts a new size. - * @alias dfareporting.sizes.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Size} params.resource Request body data - * @param {object} [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$Sizes$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Sizes$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Sizes$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Sizes$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/sizes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.sizes.list - * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. - * @alias dfareporting.sizes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.height Select only sizes with this height. - * @param {boolean=} params.iabStandard Select only IAB standard sizes. - * @param {string=} params.ids Select only sizes with these IDs. - * @param {string} params.profileId User profile ID associated with this request. - * @param {integer=} params.width Select only sizes with this width. - * @param {object} [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$Sizes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Sizes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Sizes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Sizes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Sizes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Sizes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/sizes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Sizes$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Size ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Sizes$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Size; - } - export interface Params$Resource$Sizes$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only sizes with this height. - */ - height?: number; - /** - * Select only IAB standard sizes. - */ - iabStandard?: boolean; - /** - * Select only sizes with these IDs. - */ - ids?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Select only sizes with this width. - */ - width?: number; - } - - export class Resource$Subaccounts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.subaccounts.get - * @desc Gets one subaccount by ID. - * @alias dfareporting.subaccounts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Subaccount ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Subaccounts$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Subaccounts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Subaccounts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Subaccounts$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/subaccounts/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.subaccounts.insert - * @desc Inserts a new subaccount. - * @alias dfareporting.subaccounts.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} params.resource Request body data - * @param {object} [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$Subaccounts$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Subaccounts$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Subaccounts$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Subaccounts$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Subaccounts$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/subaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.subaccounts.list - * @desc Gets a list of subaccounts, possibly filtered. This method supports paging. - * @alias dfareporting.subaccounts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only subaccounts with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Subaccounts$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Subaccounts$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Subaccounts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Subaccounts$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/subaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.subaccounts.patch - * @desc Updates an existing subaccount. This method supports patch semantics. - * @alias dfareporting.subaccounts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Subaccount ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} params.resource Request body data - * @param {object} [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$Subaccounts$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Subaccounts$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Subaccounts$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Subaccounts$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Subaccounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/subaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.subaccounts.update - * @desc Updates an existing subaccount. - * @alias dfareporting.subaccounts.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().Subaccount} params.resource Request body data - * @param {object} [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$Subaccounts$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Subaccounts$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Subaccounts$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Subaccounts$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Subaccounts$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Subaccounts$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/subaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Subaccounts$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Subaccount ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Subaccounts$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - export interface Params$Resource$Subaccounts$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only subaccounts with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Subaccounts$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Subaccount ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - export interface Params$Resource$Subaccounts$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Subaccount; - } - - export class Resource$Targetableremarketinglists { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.targetableRemarketingLists.get - * @desc Gets one remarketing list by ID. - * @alias dfareporting.targetableRemarketingLists.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Remarketing list ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Targetableremarketinglists$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Targetableremarketinglists$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Targetableremarketinglists$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Targetableremarketinglists$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetableremarketinglists$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetableremarketinglists$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/targetableRemarketingLists/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.targetableRemarketingLists.list - * @desc Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. - * @alias dfareporting.targetableRemarketingLists.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.active Select only active or only inactive targetable remarketing lists. - * @param {string} params.advertiserId Select only targetable remarketing lists targetable by these advertisers. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Targetableremarketinglists$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Targetableremarketinglists$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse - > - ): void; - list( - params: Params$Resource$Targetableremarketinglists$List, - callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Targetableremarketinglists$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$TargetableRemarketingListsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetableremarketinglists$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetableremarketinglists$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/targetableRemarketingLists' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Targetableremarketinglists$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Remarketing list ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Targetableremarketinglists$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only active or only inactive targetable remarketing lists. - */ - active?: boolean; - /** - * Select only targetable remarketing lists targetable by these advertisers. - */ - advertiserId?: string; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". - */ - name?: string; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - export class Resource$Targetingtemplates { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.targetingTemplates.get - * @desc Gets one targeting template by ID. - * @alias dfareporting.targetingTemplates.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Targeting template ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Targetingtemplates$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Targetingtemplates$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Targetingtemplates$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/targetingTemplates/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.targetingTemplates.insert - * @desc Inserts a new targeting template. - * @alias dfareporting.targetingTemplates.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} params.resource Request body data - * @param {object} [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$Targetingtemplates$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Targetingtemplates$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Targetingtemplates$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/targetingTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.targetingTemplates.list - * @desc Retrieves a list of targeting templates, optionally filtered. This method supports paging. - * @alias dfareporting.targetingTemplates.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.advertiserId Select only targeting templates with this advertiser ID. - * @param {string=} params.ids Select only targeting templates with these IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Targetingtemplates$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Targetingtemplates$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Targetingtemplates$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/targetingTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * dfareporting.targetingTemplates.patch - * @desc Updates an existing targeting template. This method supports patch semantics. - * @alias dfareporting.targetingTemplates.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Targeting template ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} params.resource Request body data - * @param {object} [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$Targetingtemplates$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Targetingtemplates$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Targetingtemplates$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/targetingTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.targetingTemplates.update - * @desc Updates an existing targeting template. - * @alias dfareporting.targetingTemplates.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().TargetingTemplate} params.resource Request body data - * @param {object} [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$Targetingtemplates$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Targetingtemplates$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Targetingtemplates$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Targetingtemplates$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Targetingtemplates$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Targetingtemplates$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/targetingTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Targetingtemplates$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Targeting template ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Targetingtemplates$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - export interface Params$Resource$Targetingtemplates$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only targeting templates with this advertiser ID. - */ - advertiserId?: string; - /** - * Select only targeting templates with these IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - export interface Params$Resource$Targetingtemplates$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Targeting template ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - export interface Params$Resource$Targetingtemplates$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TargetingTemplate; - } - - export class Resource$Userprofiles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.userProfiles.get - * @desc Gets one user profile by ID. - * @alias dfareporting.userProfiles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId The user profile 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$Userprofiles$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Userprofiles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Userprofiles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Userprofiles$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userprofiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userprofiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userProfiles.list - * @desc Retrieves list of user profiles for a user. - * @alias dfareporting.userProfiles.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Userprofiles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Userprofiles$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Userprofiles$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Userprofiles$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userprofiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userprofiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/dfareporting/v3.2/userprofiles').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$Userprofiles$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The user profile ID. - */ - profileId?: string; - } - export interface Params$Resource$Userprofiles$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - } - - export class Resource$Userrolepermissiongroups { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.userRolePermissionGroups.get - * @desc Gets one user role permission group by ID. - * @alias dfareporting.userRolePermissionGroups.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role permission group ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Userrolepermissiongroups$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Userrolepermissiongroups$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Userrolepermissiongroups$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Userrolepermissiongroups$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userrolepermissiongroups$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissiongroups$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/userRolePermissionGroups/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRolePermissionGroups.list - * @desc Gets a list of all supported user role permission groups. - * @alias dfareporting.userRolePermissionGroups.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Userrolepermissiongroups$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Userrolepermissiongroups$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$UserRolePermissionGroupsListResponse - > - ): void; - list( - params: Params$Resource$Userrolepermissiongroups$List, - callback: BodyResponseCallback< - Schema$UserRolePermissionGroupsListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$UserRolePermissionGroupsListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Userrolepermissiongroups$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$UserRolePermissionGroupsListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userrolepermissiongroups$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissiongroups$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/userRolePermissionGroups' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Userrolepermissiongroups$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role permission group ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userrolepermissiongroups$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Userrolepermissions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.userRolePermissions.get - * @desc Gets one user role permission by ID. - * @alias dfareporting.userRolePermissions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role permission ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Userrolepermissions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Userrolepermissions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Userrolepermissions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Userrolepermissions$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userrolepermissions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/userRolePermissions/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRolePermissions.list - * @desc Gets a list of user role permissions, possibly filtered. - * @alias dfareporting.userRolePermissions.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.ids Select only user role permissions with these IDs. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Userrolepermissions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Userrolepermissions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Userrolepermissions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Userrolepermissions$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Userrolepermissions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userrolepermissions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/userRolePermissions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Userrolepermissions$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role permission ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userrolepermissions$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only user role permissions with these IDs. - */ - ids?: string[]; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - - export class Resource$Userroles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.userRoles.delete - * @desc Deletes an existing user role. - * @alias dfareporting.userRoles.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Userroles$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Userroles$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Userroles$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Userroles$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/userRoles/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.get - * @desc Gets one user role by ID. - * @alias dfareporting.userRoles.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Userroles$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Userroles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Userroles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Userroles$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/userRoles/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.insert - * @desc Inserts a new user role. - * @alias dfareporting.userRoles.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} params.resource Request body data - * @param {object} [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$Userroles$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Userroles$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Userroles$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Userroles$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/userRoles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.list - * @desc Retrieves a list of user roles, possibly filtered. This method supports paging. - * @alias dfareporting.userRoles.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.accountUserRoleOnly Select only account level user roles not associated with any specific subaccount. - * @param {string=} params.ids Select only user roles with the specified IDs. - * @param {integer=} params.maxResults Maximum number of results to return. - * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. - * @param {string} params.profileId User profile ID associated with this request. - * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". - * @param {string=} params.sortField Field by which to sort the list. - * @param {string=} params.sortOrder Order of sorted results. - * @param {string=} params.subaccountId Select only user roles that belong to this subaccount. - * @param {object} [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$Userroles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Userroles$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Userroles$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Userroles$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/userRoles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.patch - * @desc Updates an existing user role. This method supports patch semantics. - * @alias dfareporting.userRoles.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id User role ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} params.resource Request body data - * @param {object} [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$Userroles$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Userroles$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Userroles$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Userroles$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/userRoles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.userRoles.update - * @desc Updates an existing user role. - * @alias dfareporting.userRoles.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {().UserRole} params.resource Request body data - * @param {object} [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$Userroles$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Userroles$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Userroles$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Userroles$Update - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userroles$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/dfareporting/v3.2/userprofiles/{profileId}/userRoles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Userroles$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userroles$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Userroles$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - export interface Params$Resource$Userroles$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Select only account level user roles not associated with any specific subaccount. - */ - accountUserRoleOnly?: boolean; - /** - * Select only user roles with the specified IDs. - */ - ids?: string[]; - /** - * Maximum number of results to return. - */ - maxResults?: number; - /** - * Value of the nextPageToken from the previous result page. - */ - pageToken?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - /** - * Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - /** - * Select only user roles that belong to this subaccount. - */ - subaccountId?: string; - } - export interface Params$Resource$Userroles$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User role ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - export interface Params$Resource$Userroles$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserRole; - } - - export class Resource$Videoformats { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * dfareporting.videoFormats.get - * @desc Gets one video format by ID. - * @alias dfareporting.videoFormats.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer} params.id Video format ID. - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Videoformats$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Videoformats$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Videoformats$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Videoformats$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Videoformats$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Videoformats$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/videoFormats/{id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * dfareporting.videoFormats.list - * @desc Lists available video formats. - * @alias dfareporting.videoFormats.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.profileId User profile ID associated with this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Videoformats$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Videoformats$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Videoformats$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Videoformats$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Videoformats$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Videoformats$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/dfareporting/v3.2/userprofiles/{profileId}/videoFormats' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Videoformats$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Video format ID. - */ - id?: number; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Videoformats$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * User profile ID associated with this request. - */ - profileId?: string; - } -} diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 967d88ff737..2a0ff853fe5 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -366,11 +366,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2CharacterMaskConfig { /** - * When masking a string, items in this list will be skipped when replacing. For example, if your string is 555-555-5555 and you ask us to skip `-` and mask 5 chars with * we would produce ***-*55-5555. + * When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP returns `***-**5-5555`. */ charactersToIgnore?: Schema$GooglePrivacyDlpV2CharsToIgnore[]; /** - * Character to mask the sensitive values&mdash;for example, "*" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number. String must have length 1. If not supplied, we will default to "*" for strings, 0 for digits. + * Character to use to mask the sensitive values&mdash;for example, `*` for an alphabetic string such as a name, or `0` for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to `*` for strings, and `0` for digits. */ maskingCharacter?: string | null; /** @@ -378,7 +378,7 @@ export namespace dlp_v2 { */ numberToMask?: number | null; /** - * Mask characters in reverse order. For example, if `masking_character` is '0', number_to_mask is 14, and `reverse_order` is false, then 1234-5678-9012-3456 -> 00000000000000-3456 If `masking_character` is '*', `number_to_mask` is 3, and `reverse_order` is true, then 12345 -> 12*** + * Mask characters in reverse order. For example, if `masking_character` is `0`, `number_to_mask` is `14`, and `reverse_order` is `false`, then the input string `1234-5678-9012-3456` is masked as `00000000000000-3456`. If `masking_character` is `*`, `number_to_mask` is `3`, and `reverse_order` is `true`, then the string `12345` is masked as `12***`. */ reverseOrder?: boolean | null; } @@ -1279,7 +1279,7 @@ export namespace dlp_v2 { */ includeQuote?: boolean | null; /** - * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. The special InfoType name "ALL_BASIC" can be used to trigger all detectors, but may change over time as new InfoTypes are added. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference. + * Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; limits?: Schema$GooglePrivacyDlpV2FindingLimits; @@ -1753,19 +1753,6 @@ export namespace dlp_v2 { */ nextPageToken?: string | null; } - /** - * Request for the list of infoTypes. - */ - export interface Schema$GooglePrivacyDlpV2ListInfoTypesRequest { - /** - * Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. - */ - filter?: string | null; - /** - * Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. - */ - languageCode?: string | null; - } /** * Response to the ListInfoTypes request. */ @@ -2097,6 +2084,10 @@ export namespace dlp_v2 { * Configuration for the inspector. */ inspectConfig?: Schema$GooglePrivacyDlpV2InspectConfig; + /** + * The geographic location to process the request. Reserved for future extensions. + */ + location?: string | null; } /** * Results of redacting an image. @@ -2149,7 +2140,7 @@ export namespace dlp_v2 { */ location?: string | null; /** - * Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoReplaceFfxFpeConfig` + * Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` */ reidentifyConfig?: Schema$GooglePrivacyDlpV2DeidentifyConfig; /** @@ -2430,7 +2421,7 @@ export namespace dlp_v2 { */ startTime?: string | null; /** - * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore or BigQuery. If not specified for BigQuery, table last modification timestamp is checked against given time span. The valid data types of the timestamp field are: for BigQuery - timestamp, date, datetime; for Datastore - timestamp. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid. + * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: `INTEGER`, `DATE`, `TIMESTAMP`, or `DATETIME` BigQuery column. For Datastore. Valid data types of the timestamp field are: `TIMESTAMP`. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid. */ timestampField?: Schema$GooglePrivacyDlpV2FieldId; } @@ -2774,30 +2765,40 @@ export namespace dlp_v2 { } export class Resource$Locations { + context: APIRequestContext; + infoTypes: Resource$Locations$Infotypes; + constructor(context: APIRequestContext) { + this.context = context; + this.infoTypes = new Resource$Locations$Infotypes(this.context); + } + } + + export class Resource$Locations$Infotypes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * dlp.locations.infoTypes + * dlp.locations.infoTypes.list * @desc Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more. - * @alias dlp.locations.infoTypes + * @alias dlp.locations.infoTypes.list * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filter Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. + * @param {string=} params.languageCode Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. * @param {string} params.location The geographic location to list info types. Reserved for future extensions. - * @param {().GooglePrivacyDlpV2ListInfoTypesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - infoTypes( - params?: Params$Resource$Locations$Infotypes, + list( + params?: Params$Resource$Locations$Infotypes$List, options?: MethodOptions ): GaxiosPromise; - infoTypes( - params: Params$Resource$Locations$Infotypes, + list( + params: Params$Resource$Locations$Infotypes$List, options: | MethodOptions | BodyResponseCallback, @@ -2805,20 +2806,20 @@ export namespace dlp_v2 { Schema$GooglePrivacyDlpV2ListInfoTypesResponse > ): void; - infoTypes( - params: Params$Resource$Locations$Infotypes, + list( + params: Params$Resource$Locations$Infotypes$List, callback: BodyResponseCallback< Schema$GooglePrivacyDlpV2ListInfoTypesResponse > ): void; - infoTypes( + list( callback: BodyResponseCallback< Schema$GooglePrivacyDlpV2ListInfoTypesResponse > ): void; - infoTypes( + list( paramsOrCallback?: - | Params$Resource$Locations$Infotypes + | Params$Resource$Locations$Infotypes$List | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -2828,12 +2829,12 @@ export namespace dlp_v2 { > ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Infotypes; + {}) as Params$Resource$Locations$Infotypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Infotypes; + params = {} as Params$Resource$Locations$Infotypes$List; options = {}; } @@ -2850,7 +2851,7 @@ export namespace dlp_v2 { /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -2872,7 +2873,7 @@ export namespace dlp_v2 { } } - export interface Params$Resource$Locations$Infotypes + export interface Params$Resource$Locations$Infotypes$List extends StandardParameters { /** * Auth client or API Key for the request @@ -2880,14 +2881,17 @@ export namespace dlp_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The geographic location to list info types. Reserved for future extensions. + * Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. */ - location?: string; - + filter?: string; /** - * Request body metadata + * Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. + */ + languageCode?: string; + /** + * The geographic location to list info types. Reserved for future extensions. */ - requestBody?: Schema$GooglePrivacyDlpV2ListInfoTypesRequest; + location?: string; } export class Resource$Organizations { @@ -7091,9 +7095,11 @@ export namespace dlp_v2 { export class Resource$Projects$Locations { context: APIRequestContext; content: Resource$Projects$Locations$Content; + image: Resource$Projects$Locations$Image; constructor(context: APIRequestContext) { this.context = context; this.content = new Resource$Projects$Locations$Content(this.context); + this.image = new Resource$Projects$Locations$Image(this.context); } } @@ -7460,6 +7466,127 @@ export namespace dlp_v2 { requestBody?: Schema$GooglePrivacyDlpV2ReidentifyContentRequest; } + export class Resource$Projects$Locations$Image { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dlp.projects.locations.image.redact + * @desc Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. + * @alias dlp.projects.locations.image.redact + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.location The geographic location to process the request. Reserved for future extensions. + * @param {string} params.parent The parent resource name, for example projects/my-project-id. + * @param {().GooglePrivacyDlpV2RedactImageRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + redact( + params?: Params$Resource$Projects$Locations$Image$Redact, + options?: MethodOptions + ): GaxiosPromise; + redact( + params: Params$Resource$Projects$Locations$Image$Redact, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GooglePrivacyDlpV2RedactImageResponse + > + ): void; + redact( + params: Params$Resource$Projects$Locations$Image$Redact, + callback: BodyResponseCallback< + Schema$GooglePrivacyDlpV2RedactImageResponse + > + ): void; + redact( + callback: BodyResponseCallback< + Schema$GooglePrivacyDlpV2RedactImageResponse + > + ): void; + redact( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Image$Redact + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GooglePrivacyDlpV2RedactImageResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Image$Redact; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Image$Redact; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2/{+parent}/locations/{location}/image:redact' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent', 'location'], + pathParams: ['location', 'parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Image$Redact + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The geographic location to process the request. Reserved for future extensions. + */ + location?: string; + /** + * The parent resource name, for example projects/my-project-id. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GooglePrivacyDlpV2RedactImageRequest; + } + export class Resource$Projects$Storedinfotypes { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index 77b12387b8e..7173e86f57d 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -505,6 +505,10 @@ export namespace dns_v1 { * Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy. */ enableInboundForwarding?: boolean | null; + /** + * Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set. + */ + enableLogging?: boolean | null; /** * Unique identifier for the resource; defined by the server (output only). */ diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index 8ab0827175d..e1770b3d94f 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -505,6 +505,10 @@ export namespace dns_v2beta1 { * Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy. */ enableInboundForwarding?: boolean | null; + /** + * Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set. + */ + enableLogging?: boolean | null; /** * Unique identifier for the resource; defined by the server (output only). */ diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index 1ade2d59ca7..3bef49b3b35 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -267,6 +267,42 @@ export namespace docs_v1 { */ textStyle?: Schema$TextStyle; } + /** + * Creates a Footer. The new footer will be applied to SectionStyle or the DocumentStyle. If a footer of the specified type already exists then a 400 bad request error will be returned. + */ + export interface Schema$CreateFooterRequest { + /** + * The type of footer to create. + */ + type?: string | null; + } + /** + * The result of creating a footer. + */ + export interface Schema$CreateFooterResponse { + /** + * The ID of the created footer. + */ + footerId?: string | null; + } + /** + * Creates a Header. The new header will be applied to SectionStyle or the DocumentStyle. If a header of the specified type already exists then a 400 bad request error will be returned. + */ + export interface Schema$CreateHeaderRequest { + /** + * The type of header to create. + */ + type?: string | null; + } + /** + * The result of creating a header. + */ + export interface Schema$CreateHeaderResponse { + /** + * The ID of the created header. + */ + headerId?: string | null; + } /** * Creates a NamedRange referencing the given range. */ @@ -1858,10 +1894,35 @@ export namespace docs_v1 { */ uri?: string | null; } + /** + * Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple discontinuous ranges. In this case, only the content in the first range will be replaced. The other ranges and their content will be deleted. In cases where replacing or deleting any ranges would result in an invalid document structure, a 400 bad request error is returned. + */ + export interface Schema$ReplaceNamedRangeContentRequest { + /** + * The ID of the named range whose content will be replaced. If there is no named range with the given ID a 400 bad request error is returned. + */ + namedRangeId?: string | null; + /** + * The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op. + */ + namedRangeName?: string | null; + /** + * Replaces the content of the specified named range(s) with the given text. + */ + text?: string | null; + } /** * A single update to apply to a document. */ export interface Schema$Request { + /** + * Creates a footer. + */ + createFooter?: Schema$CreateFooterRequest; + /** + * Creates a header. + */ + createHeader?: Schema$CreateHeaderRequest; /** * Creates a named range. */ @@ -1930,6 +1991,10 @@ export namespace docs_v1 { * Replaces an image in the document. */ replaceImage?: Schema$ReplaceImageRequest; + /** + * Replaces the content in a named range. + */ + replaceNamedRangeContent?: Schema$ReplaceNamedRangeContentRequest; /** * Unmerges cells in a table. */ @@ -1963,6 +2028,14 @@ export namespace docs_v1 { * A single response from an update. */ export interface Schema$Response { + /** + * The result of creating a footer. + */ + createFooter?: Schema$CreateFooterResponse; + /** + * The result of creating a header. + */ + createHeader?: Schema$CreateHeaderResponse; /** * The result of creating a named range. */ diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 6d59dc449ae..3fcb87c1b71 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -216,7 +216,7 @@ export namespace drive_v2 { serviceName?: string; }> | null; /** - * The total number of quota bytes. + * The total number of quota bytes. This is only relevant when quotaType is LIMITED. */ quotaBytesTotal?: string | null; /** @@ -584,7 +584,7 @@ export namespace drive_v2 { */ anchor?: string | null; /** - * The user who wrote this comment. + * The author of the comment. The author's email address and permission ID will not be populated. */ author?: Schema$User; /** @@ -670,7 +670,7 @@ export namespace drive_v2 { */ export interface Schema$CommentReply { /** - * The user who wrote this reply. + * The author of the reply. The author's email address and permission ID will not be populated. */ author?: Schema$User; /** @@ -946,7 +946,7 @@ export namespace drive_v2 { */ fullFileExtension?: string | null; /** - * Whether any users are granted file access directly on this file. This field is only populated for items in shared drives. + * Whether there are permissions directly on this file. This field is only populated for items in shared drives. */ hasAugmentedPermissions?: boolean | null; /** @@ -1493,7 +1493,7 @@ export namespace drive_v2 { */ originalFilename?: string | null; /** - * Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. + * Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions. */ pinned?: boolean | null; /** @@ -3228,7 +3228,7 @@ export namespace drive_v2 { /** * drive.comments.patch - * @desc Updates an existing comment. This method supports patch semantics. + * @desc Updates an existing comment. * @alias drive.comments.patch * @memberOf! () * @@ -7947,7 +7947,7 @@ export namespace drive_v2 { /** * drive.replies.patch - * @desc Updates an existing reply. This method supports patch semantics. + * @desc Updates an existing reply. * @alias drive.replies.patch * @memberOf! () * @@ -8461,7 +8461,7 @@ export namespace drive_v2 { /** * drive.revisions.patch - * @desc Updates a revision. This method supports patch semantics. + * @desc Updates a revision. * @alias drive.revisions.patch * @memberOf! () * diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 35f0fd9672a..ff644b8774b 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -313,7 +313,7 @@ export namespace drive_v3 { */ anchor?: string | null; /** - * The user who created the comment. + * The author of the comment. The author's email address and permission ID will not be populated. */ author?: Schema$User; /** @@ -556,7 +556,7 @@ export namespace drive_v3 { */ fullFileExtension?: string | null; /** - * Whether any users are granted file access directly on this file. This field is only populated for shared drive files. + * Whether there are permissions directly on this file. This field is only populated for items in shared drives. */ hasAugmentedPermissions?: boolean | null; /** @@ -885,7 +885,7 @@ export namespace drive_v3 { */ action?: string | null; /** - * The user who created the reply. + * The author of the reply. The author's email address and permission ID will not be populated. */ author?: Schema$User; /** @@ -2800,7 +2800,7 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {string} params.fileId The ID of the file. * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. - * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. + * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. @@ -2876,7 +2876,7 @@ export namespace drive_v3 { * * @param {object} params Parameters for request * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. - * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. + * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. @@ -3402,7 +3402,7 @@ export namespace drive_v3 { * @param {object} params Parameters for request * @param {string=} params.addParents A comma-separated list of parent IDs to add. * @param {string} params.fileId The ID of the file. - * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. + * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). * @param {string=} params.removeParents A comma-separated list of parent IDs to remove. * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. @@ -3570,7 +3570,7 @@ export namespace drive_v3 { */ ignoreDefaultVisibility?: boolean; /** - * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. + * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */ keepRevisionForever?: boolean; /** @@ -3602,7 +3602,7 @@ export namespace drive_v3 { */ ignoreDefaultVisibility?: boolean; /** - * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. + * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */ keepRevisionForever?: boolean; /** @@ -3795,7 +3795,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. + * Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */ keepRevisionForever?: boolean; /** diff --git a/src/apis/fcm/v1.ts b/src/apis/fcm/v1.ts index 58a1d15a473..7c87c160206 100644 --- a/src/apis/fcm/v1.ts +++ b/src/apis/fcm/v1.ts @@ -273,11 +273,11 @@ export namespace fcm_v1 { */ fcmOptions?: Schema$ApnsFcmOptions; /** - * HTTP request headers defined in Apple Push Notification Service. Refer to [APNs request headers](https://goo.gl/C6Yhia) for supported headers, e.g. "apns-priority": "10". + * HTTP request headers defined in Apple Push Notification Service. Refer to [APNs request headers](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) for supported headers, e.g. "apns-priority": "10". */ headers?: {[key: string]: string} | null; /** - * APNs payload as a JSON object, including both `aps` dictionary and custom payload. See [Payload Key Reference](https://goo.gl/32Pl5W). If present, it overrides google.firebase.fcm.v1.Notification.title and google.firebase.fcm.v1.Notification.body. + * APNs payload as a JSON object, including both `aps` dictionary and custom payload. See [Payload Key Reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification). If present, it overrides google.firebase.fcm.v1.Notification.title and google.firebase.fcm.v1.Notification.body. */ payload?: {[key: string]: any} | null; } @@ -358,7 +358,7 @@ export namespace fcm_v1 { */ condition?: string | null; /** - * Input only. Arbitrary key/value payload. + * Input only. Arbitrary key/value payload. The key should not be a reserved word ("from", "message_type", or any word starting with "google" or "gcm"). */ data?: {[key: string]: string} | null; /** diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index c0fc4607688..18d56a09f86 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -215,6 +215,10 @@ export namespace file_v1 { * The scheduled end time for the maintenance. */ endTime?: string | null; + /** + * The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy. + */ + rolloutManagementPolicy?: string | null; /** * The scheduled start time for the maintenance. */ @@ -1053,7 +1057,7 @@ export namespace file_v1 { * * @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.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" + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1204,7 +1208,7 @@ export namespace file_v1 { */ name?: string; /** - * 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" + * 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" */ updateMask?: string; diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 0cc5e3c96b8..1bbc1c50d57 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -215,6 +215,10 @@ export namespace file_v1beta1 { * The scheduled end time for the maintenance. */ endTime?: string | null; + /** + * The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy. + */ + rolloutManagementPolicy?: string | null; /** * The scheduled start time for the maintenance. */ @@ -1053,7 +1057,7 @@ export namespace file_v1beta1 { * * @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.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" + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1204,7 +1208,7 @@ export namespace file_v1beta1 { */ name?: string; /** - * 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" + * 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" */ updateMask?: string; diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index d91fe38cf43..2b87c147f95 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -172,7 +172,7 @@ export namespace firebase_v1beta1 { */ analyticsProperty?: Schema$AnalyticsProperty; /** - * A map of `AppId` to `StreamId` for each Firebase App in the specified `FirebaseProject`. Each `AppId` and `StreamId` appears only once. + * For Android Apps and iOS Apps: A map of `app` to `streamId` for each Firebase App in the specified `FirebaseProject`. Each `app` and `streamId` appears only once.<br> <br> For Web Apps: A map of `app` to `streamId` and `measurementId` for each Firebase App in the specified `FirebaseProject`. Each `app`, `streamId`, and `measurementId` appears only once. */ streamMappings?: Schema$StreamMapping[]; } @@ -551,9 +551,13 @@ export namespace firebase_v1beta1 { */ export interface Schema$StreamMapping { /** - * The fully qualified resource name of the Firebase App associated with the Google Analytics data stream, in the format: <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> or <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code> + * The fully qualified resource name of the Firebase App associated with the Google Analytics data stream, in the format: <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code> or <code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> or <code>projects/<var>projectId</var>/webApps/<var>appId</var></code> */ app?: string | null; + /** + * Applicable for Firebase Web Apps only.<br> <br>The unique Google-assigned identifier of the Google Analytics web stream associated with the Firebase Web App. Firebase SDKs use this ID to interact with Google Analytics APIs. <br> <br>Learn more about this ID and Google Analytics web streams in the [Analytics documentation](https://support.google.com/analytics/topic/9303475). + */ + measurementId?: string | null; /** * The unique Google-assigned identifier of the Google Analytics data stream associated with the Firebase App. <br> <br>Learn more about Google Analytics data streams in the [Analytics documentation](https://support.google.com/analytics/answer/9303323). */ @@ -621,6 +625,10 @@ export namespace firebase_v1beta1 { * The ID of the project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). <br> <br>This field is omitted if the default GCP resource location has not been finalized yet. To set your project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase services to your project. */ locationId?: string | null; + /** + * The unique Google-assigned identifier of the Google Analytics web stream associated with the Firebase Web App. Firebase SDKs use this ID to interact with Google Analytics APIs. <br> <br>This field is only present if the App is linked to a web stream in a Google Analytics App + Web property. Learn more about this ID and Google Analytics web streams in the [Analytics documentation](https://support.google.com/analytics/topic/9303475). <br> <br>To generate a `measurementId` and link the Web App with a Google Analytics web stream, call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics). + */ + measurementId?: string | null; /** * The sender ID for use with Firebase Cloud Messaging. */ @@ -929,7 +937,7 @@ export namespace firebase_v1beta1 { /** * firebase.projects.addGoogleAnalytics - * @desc Links a FirebaseProject with an existing [Google Analytics account](http://www.google.com/analytics/).

              Using this call, you can either:
              • Provision a new Google Analytics property and associate the new property with your `FirebaseProject`.
              • Associate an existing Google Analytics property with your `FirebaseProject`.

              Note that when you call `AddGoogleAnalytics`:
              • Any Firebase Apps already in your `FirebaseProject` are automatically provisioned as new data streams in the Google Analytics property.
              • Any data streams already in the Google Analytics property are automatically associated with their corresponding Firebase Apps (only applies when an app's `packageName` or `bundleId` match those for an existing data stream).
              Learn more about the hierarchy and structure of Google Analytics accounts in the [Analytics documentation](https://support.google.com/analytics/answer/9303323).

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

              To call `AddGoogleAnalytics`, a member must be an Owner for the existing `FirebaseProject` and have the [`Edit` permission](https://support.google.com/analytics/answer/2884495) for the Google Analytics account.

              If a `FirebaseProject` already has Google Analytics enabled, and you call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different from the currently associated property, then the call will fail. Analytics may have already been enabled in the Firebase console or by specifying `timeZone` and `regionCode` in the call to [`AddFirebase`](../../v1beta1/projects/addFirebase). + * @desc Links a FirebaseProject with an existing [Google Analytics account](http://www.google.com/analytics/).

              Using this call, you can either:
              • Specify an `analyticsAccountId` to provision a new Google Analytics property within the specified account and associate the new property with your `FirebaseProject`.
              • Specify an existing `analyticsPropertyId` to associate the property with your `FirebaseProject`.

              Note that when you call `AddGoogleAnalytics`:
              1. The first check determines if any existing data streams in the Google Analytics property correspond to any existing Firebase Apps in your `FirebaseProject` (based on the `packageName` or `bundleId` associated with the data stream). Then, as applicable, the data streams and apps are linked. Note that this auto-linking only applies to Android Apps and iOS Apps.
              2. If no corresponding data streams are found for your Firebase Apps, new data streams are provisioned in the Google Analytics property for each of your Firebase Apps. Note that a new data stream is always provisioned for a Web App even if it was previously associated with a data stream in your Analytics property.
              Learn more about the hierarchy and structure of Google Analytics accounts in the [Analytics documentation](https://support.google.com/analytics/answer/9303323).

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

              To call `AddGoogleAnalytics`, a member must be an Owner for the existing `FirebaseProject` and have the [`Edit` permission](https://support.google.com/analytics/answer/2884495) for the Google Analytics account.

              If a `FirebaseProject` already has Google Analytics enabled, and you call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different from the currently associated property, then the call will fail. Analytics may have already been enabled in the Firebase console or by specifying `timeZone` and `regionCode` in the call to [`AddFirebase`](../../v1beta1/projects/addFirebase). * @alias firebase.projects.addGoogleAnalytics * @memberOf! () * @@ -1372,7 +1380,7 @@ export namespace firebase_v1beta1 { /** * firebase.projects.removeAnalytics - * @desc Unlinks the specified `FirebaseProject` from its Google Analytics account.

              This call removes the association of the specified `FirebaseProject` with its current Google Analytics property. However, this call does not delete the Google Analytics resources, such as the Google Analytics property or any data streams.

              These resources may be re-associated later to the `FirebaseProject` by calling [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and specifying the same `analyticsPropertyId`.

              To call `RemoveAnalytics`, a member must be an Owner for the `FirebaseProject`. + * @desc Unlinks the specified `FirebaseProject` from its Google Analytics account.

              This call removes the association of the specified `FirebaseProject` with its current Google Analytics property. However, this call does not delete the Google Analytics resources, such as the Google Analytics property or any data streams.

              These resources may be re-associated later to the `FirebaseProject` by calling [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps, this call re-links data streams with their corresponding apps. However, for Web Apps, this call provisions a new data stream for each Web App.

              To call `RemoveAnalytics`, a member must be an Owner for the `FirebaseProject`. * @alias firebase.projects.removeAnalytics * @memberOf! () * diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index 007db771cf9..b7e7080d7dd 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -315,6 +315,19 @@ export namespace firebasehosting_v1beta1 { */ uploadUrl?: string | null; } + /** + * Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. + */ + export interface Schema$PreviewConfig { + /** + * If true, preview URLs are enabled for this version. + */ + active?: boolean | null; + /** + * Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. + */ + expireTime?: string | null; + } /** * A [`redirect`](/docs/hosting/full-config#redirects) represents the configuration for returning an HTTP redirect response given a matching request URL path. */ @@ -476,6 +489,10 @@ export namespace firebasehosting_v1beta1 { * The unique identifier for a version, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint. */ name?: string | null; + /** + * Version preview configuration for the site version. This configuration specfies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version. + */ + preview?: Schema$PreviewConfig; /** * The deploy status of a version. <br> <br>For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. <br> <br>Note that if you leave the version in the `CREATED` state for more than 12&nbsp;hours, the system will automatically mark the version as `ABANDONED`. <br> <br>You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint. */ diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index 4695005e667..c77b9d87e1a 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -519,7 +519,7 @@ export namespace fitness_v1 { /** * fitness.users.dataset.aggregate - * @desc Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggreated into exactly one bucket type per request. + * @desc Aggregates data of a certain type or stream into buckets divided by a given type of boundary. Multiple data sets of multiple types and from multiple sources can be aggregated into exactly one bucket type per request. * @alias fitness.users.dataset.aggregate * @memberOf! () * diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index 490e7d6074c..521e568e8af 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -97,8 +97,6 @@ export namespace games_v1 { metagame: Resource$Metagame; players: Resource$Players; pushtokens: Resource$Pushtokens; - questMilestones: Resource$Questmilestones; - quests: Resource$Quests; revisions: Resource$Revisions; rooms: Resource$Rooms; scores: Resource$Scores; @@ -121,8 +119,6 @@ export namespace games_v1 { this.metagame = new Resource$Metagame(this.context); this.players = new Resource$Players(this.context); this.pushtokens = new Resource$Pushtokens(this.context); - this.questMilestones = new Resource$Questmilestones(this.context); - this.quests = new Resource$Quests(this.context); this.revisions = new Resource$Revisions(this.context); this.rooms = new Resource$Rooms(this.context); this.scores = new Resource$Scores(this.context); @@ -1208,6 +1204,7 @@ export namespace games_v1 { * The ID of the player. */ playerId?: string | null; + playerStattus?: string | null; /** * The player's profile settings. Controls whether or not the player's profile is visible to other players. */ @@ -1558,159 +1555,6 @@ export namespace games_v1 { */ kind?: string | null; } - /** - * This is a JSON template for a Quest resource. - */ - export interface Schema$Quest { - /** - * The timestamp at which the user accepted the quest in milliseconds since the epoch in UTC. Only present if the player has accepted the quest. - */ - acceptedTimestampMillis?: string | null; - /** - * The ID of the application this quest is part of. - */ - applicationId?: string | null; - /** - * The banner image URL for the quest. - */ - bannerUrl?: string | null; - /** - * The description of the quest. - */ - description?: string | null; - /** - * The timestamp at which the quest ceases to be active in milliseconds since the epoch in UTC. - */ - endTimestampMillis?: string | null; - /** - * The icon image URL for the quest. - */ - iconUrl?: string | null; - /** - * The ID of the quest. - */ - id?: string | null; - /** - * Indicates whether the banner image being returned is a default image, or is game-provided. - */ - isDefaultBannerUrl?: boolean | null; - /** - * Indicates whether the icon image being returned is a default image, or is game-provided. - */ - isDefaultIconUrl?: boolean | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string games#quest. - */ - kind?: string | null; - /** - * The timestamp at which the quest was last updated by the user in milliseconds since the epoch in UTC. Only present if the player has accepted the quest. - */ - lastUpdatedTimestampMillis?: string | null; - /** - * The quest milestones. - */ - milestones?: Schema$QuestMilestone[]; - /** - * The name of the quest. - */ - name?: string | null; - /** - * The timestamp at which the user should be notified that the quest will end soon in milliseconds since the epoch in UTC. - */ - notifyTimestampMillis?: string | null; - /** - * The timestamp at which the quest becomes active in milliseconds since the epoch in UTC. - */ - startTimestampMillis?: string | null; - /** - * The state of the quest. Possible values are: - "UPCOMING": The quest is upcoming. The user can see the quest, but cannot accept it until it is open. - "OPEN": The quest is currently open and may be accepted at this time. - "ACCEPTED": The user is currently participating in this quest. - "COMPLETED": The user has completed the quest. - "FAILED": The quest was attempted but was not completed before the deadline expired. - "EXPIRED": The quest has expired and was not accepted. - "DELETED": The quest should be deleted from the local database. - */ - state?: string | null; - } - /** - * This is a JSON template for a Quest Criterion Contribution resource. - */ - export interface Schema$QuestContribution { - /** - * The formatted value of the contribution as a string. Format depends on the configuration for the associated event definition in the Play Games Developer Console. - */ - formattedValue?: string | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string games#questContribution. - */ - kind?: string | null; - /** - * The value of the contribution. - */ - value?: string | null; - } - /** - * This is a JSON template for a Quest Criterion resource. - */ - export interface Schema$QuestCriterion { - /** - * The total number of times the associated event must be incremented for the player to complete this quest. - */ - completionContribution?: Schema$QuestContribution; - /** - * The number of increments the player has made toward the completion count event increments required to complete the quest. This value will not exceed the completion contribution. There will be no currentContribution until the player has accepted the quest. - */ - currentContribution?: Schema$QuestContribution; - /** - * The ID of the event the criterion corresponds to. - */ - eventId?: string | null; - /** - * The value of the event associated with this quest at the time that the quest was accepted. This value may change if event increments that took place before the start of quest are uploaded after the quest starts. There will be no initialPlayerProgress until the player has accepted the quest. - */ - initialPlayerProgress?: Schema$QuestContribution; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string games#questCriterion. - */ - kind?: string | null; - } - /** - * This is a JSON template for a list of quest objects. - */ - export interface Schema$QuestListResponse { - /** - * The quests. - */ - items?: Schema$Quest[]; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string games#questListResponse. - */ - kind?: string | null; - /** - * Token corresponding to the next page of results. - */ - nextPageToken?: string | null; - } - /** - * This is a JSON template for a Quest Milestone resource. - */ - export interface Schema$QuestMilestone { - /** - * The completion reward data of the milestone, represented as a Base64-encoded string. This is a developer-specified binary blob with size between 0 and 2 KB before encoding. - */ - completionRewardData?: string | null; - /** - * The criteria of the milestone. - */ - criteria?: Schema$QuestCriterion[]; - /** - * The milestone ID. - */ - id?: string | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string games#questMilestone. - */ - kind?: string | null; - /** - * The current state of the milestone. Possible values are: - "COMPLETED_NOT_CLAIMED" - The milestone is complete, but has not yet been claimed. - "CLAIMED" - The milestone is complete and has been claimed. - "NOT_COMPLETED" - The milestone has not yet been completed. - "NOT_STARTED" - The milestone is for a quest that has not yet been accepted. - */ - state?: string | null; - } /** * This is a JSON template for the result of checking a revision. */ @@ -4587,302 +4431,6 @@ export namespace games_v1 { requestBody?: Schema$PushToken; } - export class Resource$Questmilestones { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * games.questMilestones.claim - * @desc Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user. - * @alias games.questMilestones.claim - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.milestoneId The ID of the milestone. - * @param {string} params.questId The ID of the quest. - * @param {string} params.requestId A numeric ID to ensure that the request is handled correctly across retries. Your client application must generate this ID randomly. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - claim( - params?: Params$Resource$Questmilestones$Claim, - options?: MethodOptions - ): GaxiosPromise; - claim( - params: Params$Resource$Questmilestones$Claim, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - claim( - params: Params$Resource$Questmilestones$Claim, - callback: BodyResponseCallback - ): void; - claim(callback: BodyResponseCallback): void; - claim( - paramsOrCallback?: - | Params$Resource$Questmilestones$Claim - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Questmilestones$Claim; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Questmilestones$Claim; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1/quests/{questId}/milestones/{milestoneId}/claim' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['questId', 'milestoneId', 'requestId'], - pathParams: ['milestoneId', 'questId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Questmilestones$Claim - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the milestone. - */ - milestoneId?: string; - /** - * The ID of the quest. - */ - questId?: string; - /** - * A numeric ID to ensure that the request is handled correctly across retries. Your client application must generate this ID randomly. - */ - requestId?: string; - } - - export class Resource$Quests { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * games.quests.accept - * @desc Indicates that the currently authorized user will participate in the quest. - * @alias games.quests.accept - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.language The preferred language to use for strings returned by this method. - * @param {string} params.questId The ID of the quest. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - accept( - params?: Params$Resource$Quests$Accept, - options?: MethodOptions - ): GaxiosPromise; - accept( - params: Params$Resource$Quests$Accept, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - accept( - params: Params$Resource$Quests$Accept, - callback: BodyResponseCallback - ): void; - accept(callback: BodyResponseCallback): void; - accept( - paramsOrCallback?: - | Params$Resource$Quests$Accept - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Quests$Accept; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Quests$Accept; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/games/v1/quests/{questId}/accept').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['questId'], - pathParams: ['questId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * games.quests.list - * @desc Get a list of quests for your application and the currently authenticated player. - * @alias games.quests.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.language The preferred language to use for strings returned by this method. - * @param {integer=} params.maxResults The maximum number of quest resources to return in the response, used for paging. For any response, the actual number of quest resources returned may be less than the specified maxResults. Acceptable values are 1 to 50, inclusive. (Default: 50). - * @param {string=} params.pageToken The token returned by the previous request. - * @param {string} params.playerId A player ID. A value of me may be used in place of the authenticated player's 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$Quests$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Quests$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Quests$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Quests$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Quests$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Quests$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/v1/players/{playerId}/quests').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['playerId'], - pathParams: ['playerId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Quests$Accept extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The preferred language to use for strings returned by this method. - */ - language?: string; - /** - * The ID of the quest. - */ - questId?: string; - } - export interface Params$Resource$Quests$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The preferred language to use for strings returned by this method. - */ - language?: string; - /** - * The maximum number of quest resources to return in the response, used for paging. For any response, the actual number of quest resources returned may be less than the specified maxResults. Acceptable values are 1 to 50, inclusive. (Default: 50). - */ - maxResults?: number; - /** - * The token returned by the previous request. - */ - pageToken?: string; - /** - * A player ID. A value of me may be used in place of the authenticated player's ID. - */ - playerId?: string; - } - export class Resource$Revisions { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/gamesManagement/v1management.ts b/src/apis/gamesManagement/v1management.ts index c1bbab9e5ae..6c9c5b45cdf 100644 --- a/src/apis/gamesManagement/v1management.ts +++ b/src/apis/gamesManagement/v1management.ts @@ -93,7 +93,6 @@ export namespace gamesManagement_v1management { applications: Resource$Applications; events: Resource$Events; players: Resource$Players; - quests: Resource$Quests; rooms: Resource$Rooms; scores: Resource$Scores; turnBasedMatches: Resource$Turnbasedmatches; @@ -108,7 +107,6 @@ export namespace gamesManagement_v1management { this.applications = new Resource$Applications(this.context); this.events = new Resource$Events(this.context); this.players = new Resource$Players(this.context); - this.quests = new Resource$Quests(this.context); this.rooms = new Resource$Rooms(this.context); this.scores = new Resource$Scores(this.context); this.turnBasedMatches = new Resource$Turnbasedmatches(this.context); @@ -304,6 +302,7 @@ export namespace gamesManagement_v1management { * The ID of the player. */ playerId?: string | null; + playerStattus?: string | null; /** * The player's profile settings. Controls whether or not the player's profile is visible to other players. */ @@ -353,19 +352,6 @@ export namespace gamesManagement_v1management { kind?: string | null; profileVisible?: boolean | null; } - /** - * This is a JSON template for multiple quests reset all request. - */ - export interface Schema$QuestsResetMultipleForAllRequest { - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#questsResetMultipleForAllRequest. - */ - kind?: string | null; - /** - * The IDs of quests to reset. - */ - quest_ids?: string[] | null; - } /** * This is a JSON template for multiple scores reset all request. */ @@ -1504,415 +1490,6 @@ export namespace gamesManagement_v1management { playerId?: string; } - export class Resource$Quests { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * gamesManagement.quests.reset - * @desc Resets all player progress on the quest with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. - * @alias gamesManagement.quests.reset - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.questId The ID of the quest. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - reset( - params?: Params$Resource$Quests$Reset, - options?: MethodOptions - ): GaxiosPromise; - reset( - params: Params$Resource$Quests$Reset, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reset( - params: Params$Resource$Quests$Reset, - callback: BodyResponseCallback - ): void; - reset(callback: BodyResponseCallback): void; - reset( - paramsOrCallback?: - | Params$Resource$Quests$Reset - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Quests$Reset; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Quests$Reset; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1management/quests/{questId}/reset' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['questId'], - pathParams: ['questId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesManagement.quests.resetAll - * @desc Resets all player progress on all quests for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. - * @alias gamesManagement.quests.resetAll - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - resetAll( - params?: Params$Resource$Quests$Resetall, - options?: MethodOptions - ): GaxiosPromise; - resetAll( - params: Params$Resource$Quests$Resetall, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resetAll( - params: Params$Resource$Quests$Resetall, - callback: BodyResponseCallback - ): void; - resetAll(callback: BodyResponseCallback): void; - resetAll( - paramsOrCallback?: - | Params$Resource$Quests$Resetall - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Quests$Resetall; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Quests$Resetall; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/games/v1management/quests/reset').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesManagement.quests.resetAllForAllPlayers - * @desc Resets all draft quests for all players. This method is only available to user accounts for your developer console. - * @alias gamesManagement.quests.resetAllForAllPlayers - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - resetAllForAllPlayers( - params?: Params$Resource$Quests$Resetallforallplayers, - options?: MethodOptions - ): GaxiosPromise; - resetAllForAllPlayers( - params: Params$Resource$Quests$Resetallforallplayers, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resetAllForAllPlayers( - params: Params$Resource$Quests$Resetallforallplayers, - callback: BodyResponseCallback - ): void; - resetAllForAllPlayers(callback: BodyResponseCallback): void; - resetAllForAllPlayers( - paramsOrCallback?: - | Params$Resource$Quests$Resetallforallplayers - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Quests$Resetallforallplayers; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Quests$Resetallforallplayers; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1management/quests/resetAllForAllPlayers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesManagement.quests.resetForAllPlayers - * @desc Resets all player progress on the quest with the given ID for all players. This method is only available to user accounts for your developer console. Only draft quests can be reset. - * @alias gamesManagement.quests.resetForAllPlayers - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.questId The ID of the quest. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - resetForAllPlayers( - params?: Params$Resource$Quests$Resetforallplayers, - options?: MethodOptions - ): GaxiosPromise; - resetForAllPlayers( - params: Params$Resource$Quests$Resetforallplayers, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resetForAllPlayers( - params: Params$Resource$Quests$Resetforallplayers, - callback: BodyResponseCallback - ): void; - resetForAllPlayers(callback: BodyResponseCallback): void; - resetForAllPlayers( - paramsOrCallback?: - | Params$Resource$Quests$Resetforallplayers - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Quests$Resetforallplayers; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Quests$Resetforallplayers; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1management/quests/{questId}/resetForAllPlayers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['questId'], - pathParams: ['questId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesManagement.quests.resetMultipleForAllPlayers - * @desc Resets quests with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft quests may be reset. - * @alias gamesManagement.quests.resetMultipleForAllPlayers - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().QuestsResetMultipleForAllRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - resetMultipleForAllPlayers( - params?: Params$Resource$Quests$Resetmultipleforallplayers, - options?: MethodOptions - ): GaxiosPromise; - resetMultipleForAllPlayers( - params: Params$Resource$Quests$Resetmultipleforallplayers, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resetMultipleForAllPlayers( - params: Params$Resource$Quests$Resetmultipleforallplayers, - callback: BodyResponseCallback - ): void; - resetMultipleForAllPlayers(callback: BodyResponseCallback): void; - resetMultipleForAllPlayers( - paramsOrCallback?: - | Params$Resource$Quests$Resetmultipleforallplayers - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Quests$Resetmultipleforallplayers; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Quests$Resetmultipleforallplayers; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1management/quests/resetMultipleForAllPlayers' - ).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$Quests$Reset extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the quest. - */ - questId?: string; - } - export interface Params$Resource$Quests$Resetall extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - } - export interface Params$Resource$Quests$Resetallforallplayers - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - } - export interface Params$Resource$Quests$Resetforallplayers - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the quest. - */ - questId?: string; - } - export interface Params$Resource$Quests$Resetmultipleforallplayers - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$QuestsResetMultipleForAllRequest; - } - export class Resource$Rooms { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 3bc78c13578..b8ff566adf2 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -196,7 +196,7 @@ export namespace healthcare_v1beta1 { */ name?: string | null; /** - * The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources (e.g., HL7 messages) where no explicit timezone is specified. + * The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified. */ timeZone?: string | null; } @@ -239,20 +239,37 @@ export namespace healthcare_v1beta1 { */ config?: Schema$DeidentifyConfig; /** - * The name of the dataset resource to create and write the redacted data to (e.g., * 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 as the source dataset. De-identifying data across multiple projects is not supported. */ destinationDataset?: string | null; } + /** + * Creates a new DICOM store with sensitive information de-identified. + */ + export interface Schema$DeidentifyDicomStoreRequest { + /** + * De-identify configuration. + */ + config?: Schema$DeidentifyConfig; + /** + * The name of the DICOM store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_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 DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. + */ + destinationStore?: string | null; + /** + * Filter configuration. + */ + filterConfig?: Schema$DicomFilterConfig; + } /** * Contains the status of the Deidentify operation. */ export interface Schema$DeidentifyErrorDetails { /** - * Number of resources failed to process. + * Number of resources that failed to process. */ failureResourceCount?: string | null; /** - * Number of stores failed to process. + * Number of stores that failed to process. */ failureStoreCount?: string | null; /** @@ -264,10 +281,31 @@ export namespace healthcare_v1beta1 { */ successStoreCount?: string | null; } + /** + * Creates a new FHIR store with sensitive information de-identified. + */ + export interface Schema$DeidentifyFhirStoreRequest { + /** + * Deidentify configuration. + */ + 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. + */ + destinationStore?: string | null; + /** + * A filter specifying the resources to include in the output. If not specified, all resources are included in the output. + */ + resourceFilter?: Schema$FhirFilter; + } /** * Contains a detailed summary of the Deidentify operation. */ export interface Schema$DeidentifySummary { + /** + * Number of resources that failed to process. The failures might be caused by: * Invalid user input data * Transient errors that could be skipped + */ + failureResourceCount?: string | null; /** * Number of resources successfully processed. */ @@ -298,6 +336,15 @@ export namespace healthcare_v1beta1 { */ skipIdRedaction?: boolean | null; } + /** + * Specifies the filter configuration for DICOM resources. + */ + export interface Schema$DicomFilterConfig { + /** + * The Cloud Storage location of the filter configuration file. The `gcs_uri` must be in the format `gs://bucket/path/to/object`. The filter configuration file must contain a list of resource paths separated by newline characters (x/ or \rx/). Each resource path must be in the format "/studies/{studyUID}[/series/{seriesUID}[/instances/{instanceUID}]]" The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. + */ + resourcePathsGcsUri?: string | null; + } /** * Represents a DICOM store. */ @@ -333,7 +380,7 @@ export namespace healthcare_v1beta1 { resource?: string | null; } /** - * Exports data from the specified DICOM store. If a given resource (e.g., a DICOM object with the same SOPInstance UID) already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data will persist when the DICOM store from which it was exported is deleted. + * Exports data from the specified DICOM store. If a given resource, such as a DICOM object with the same SOPInstance UID, already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data persists when the DICOM store from which it was exported is deleted. */ export interface Schema$ExportDicomDataRequest { /** @@ -380,32 +427,37 @@ export namespace healthcare_v1beta1 { title?: string | null; } /** - * Specifies how de-identification of a FHIR store should be handled. + * Specifies how to handle de-identification of a FHIR store. */ export interface Schema$FhirConfig { /** - * Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata will be 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. */ fieldMetadataList?: Schema$FieldMetadata[]; } + /** + * Filter configuration. + */ + export interface Schema$FhirFilter { + /** + * List of resources to include in the output. If this list is empty or not specified, all resources are included in the output. + */ + resources?: Schema$Resources; + } /** * Represents a FHIR store. */ export interface Schema$FhirStore { /** - * Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as GetPatientEverything, will not return all the results if broken references exist. + * Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. */ disableReferentialIntegrity?: boolean | null; /** - * Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations will cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for attempts to read the historical versions. + * Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. */ disableResourceVersioning?: boolean | null; /** - * Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. - */ - enableHistoryImport?: boolean | null; - /** - * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. + * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. */ enableUpdateCreate?: boolean | null; /** @@ -417,7 +469,7 @@ export namespace healthcare_v1beta1 { */ name?: string | null; /** - * If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes will contain a map with a string describing the action that has triggered the notification, e.g. "action":"CreateResource". + * If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". */ notificationConfig?: Schema$NotificationConfig; } @@ -430,16 +482,38 @@ 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. e.g. "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, MimeTypeCode, Oid, String, Uri, Uuid, Xhtml. + * 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, MimeTypeCode, Oid, String, Uri, Uuid, Xhtml. */ paths?: string[] | null; } /** - * The BigQuery table where the output should be written. + * Contains a summary of the DeidentifyDicomStore operation. + */ + export interface Schema$GoogleCloudHealthcareV1beta1DeidentifyDeidentifyDicomStoreSummary { + /** + * Number of objects that processing failed for. + */ + failureResourceCount?: string | null; + /** + * Number of objects successfully processed. + */ + successResourceCount?: string | null; + } + /** + * Contains a summary of the DeidentifyFhirStore operation. + */ + export interface Schema$GoogleCloudHealthcareV1beta1DeidentifyDeidentifyFhirStoreSummary { + /** + * Number of resources successfully processed. + */ + successResourceCount?: string | null; + } + /** + * The BigQuery table where the server writes the output. */ export interface Schema$GoogleCloudHealthcareV1beta1DicomBigQueryDestination { /** - * If the destination table already exists and this flag is `TRUE`, the table will be overwritten by the contents of the DICOM store. If the flag is not set and the destination table already exists, the export call returns an error. + * If the destination table already exists and this flag is `TRUE`, the table is overwritten by the contents of the DICOM store. If the flag is not set and the destination table already exists, the export call returns an error. */ force?: boolean | null; /** @@ -448,15 +522,15 @@ export namespace healthcare_v1beta1 { tableUri?: string | null; } /** - * The Cloud Storage location where the output should be written, and the export configuration. + * The Cloud Storage location where the server writes the output and the export configuration. */ export interface Schema$GoogleCloudHealthcareV1beta1DicomGcsDestination { /** - * MIME types supported by DICOM spec. Each file will be written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component will exist only for multi-frame instances. Refer to the DICOM conformance statement for permissible MIME types: https://cloud.google.com/healthcare/docs/dicom#wado-rs The following extensions will be used for output files: application/dicom -> .dcm image/jpeg -> .jpg image/png -> .png If unspecified, the instances will be exported in their original DICOM format. + * 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. */ mimeType?: string | null; /** - * The Cloud Storage destination to export to. URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. + * The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes the result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. */ uriPrefix?: string | null; } @@ -585,7 +659,7 @@ export namespace healthcare_v1beta1 { */ name?: string | null; /** - * The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications will be sent. Supplied by the client. + * The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications are sent. Supplied by the client. */ notificationConfig?: Schema$NotificationConfig; /** @@ -611,7 +685,7 @@ export namespace healthcare_v1beta1 { extensions?: Array<{[key: string]: any}> | null; } /** - * Specifies how de-identification of image pixel should be handled. + * Specifies how to handle de-identification of image pixels. */ export interface Schema$ImageConfig { /** @@ -624,12 +698,12 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ImportDicomDataErrorDetails { /** - * Deprecated. Use only for debugging purposes. Contains sample errors encountered in imports of individual resources (for example, a Cloud Storage object). + * Deprecated. Use only for debugging purposes. Contains sample errors encountered in imports of individual resources. For example, a Cloud Storage object. */ sampleErrors?: Schema$ErrorDetail[]; } /** - * Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API will accept duplicate DICOM instances, by simply ignoring the newly pushed instance (it will not overwrite). + * Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API accepts duplicate DICOM instances by ignoring the newly-pushed instance. It does not overwrite. */ export interface Schema$ImportDicomDataRequest { /** @@ -859,11 +933,11 @@ export namespace healthcare_v1beta1 { sendTime?: string | null; } /** - * Specifies where notifications should be sent upon changes to a data store. + * Specifies where to send notifications upon changes to a data store. */ export interface Schema$NotificationConfig { /** - * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail. + * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. cloud-healthcare@system.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. */ pubsubTopic?: string | null; } @@ -925,7 +999,7 @@ export namespace healthcare_v1beta1 { */ allowNullHeader?: boolean | null; /** - * Byte(s) to be used as the segment terminator. If this is unset, '\r' will be used as segment terminator. + * Byte(s) to use as the segment terminator. If this is unset, '\r' is used as segment terminator. */ segmentTerminator?: string | null; } @@ -934,7 +1008,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$PatientId { /** - * ID type, e.g. MRN or NHS. + * ID type. For example, MRN or NHS. */ type?: string | null; /** @@ -943,7 +1017,7 @@ export namespace healthcare_v1beta1 { value?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -951,15 +1025,15 @@ export namespace healthcare_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -981,19 +1055,28 @@ export namespace healthcare_v1beta1 { success?: string | null; } /** - * Define how to redact sensitive values. Default behaviour is erase, e.g. "My name is Jake." becomes "My name is ." + * Define how to redact sensitive values. Default behaviour is erase. For example, "My name is Jake." becomes "My name is ." */ export interface Schema$RedactConfig {} /** * When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. For example, "My name is Jake" becomes "My name is [PERSON_NAME]." The TRANSFORM action is equivalent to redacting. */ export interface Schema$ReplaceWithInfoTypeConfig {} + /** + * A list of FHIR resources. + */ + export interface Schema$Resources { + /** + * List of resources IDs. For example, "Patient/1234". + */ + resources?: string[] | null; + } /** * Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. */ export interface Schema$SchemaConfig { /** - * The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. + * The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. */ recursiveStructureDepth?: string | null; /** @@ -1015,15 +1098,15 @@ export namespace healthcare_v1beta1 { */ export interface Schema$Segment { /** - * A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: - (0.1, "foo"): Component 1 of Field 0 has the value "foo". - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value "bar". - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, has the value "baz". + * A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: * (0.1, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c". */ fields?: {[key: string]: string} | null; /** - * A string that indicates the type of segment, e.g., EVN, PID. + * A string that indicates the type of segment. For example, EVN or PID. */ segmentId?: string | null; /** - * Set ID for segments that can be in a set. This can be empty if it is missing or it is not applicable. + * Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable. */ setId?: string | null; } @@ -1480,7 +1563,7 @@ export namespace healthcare_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.datasetId The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. - * @param {string} params.parent The name of the project in which the dataset should be created (e.g., `projects/{project_id}/locations/{location_id}`). + * @param {string} params.parent The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. * @param {().Dataset} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1550,7 +1633,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.deidentify - * @desc Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, details field type is DeidentifyErrorDetails. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + * @desc Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, error details field type is DeidentifyErrorDetails. Errors are also logged to Stackdriver Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). * @example * * // BEFORE RUNNING: * // --------------- @@ -1606,7 +1689,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.sourceDataset Source dataset resource name. (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * @param {string} params.sourceDataset Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * @param {().DeidentifyDatasetRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1725,7 +1808,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the dataset to delete (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * @param {string} params.name The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1841,7 +1924,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the dataset to read (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * @param {string} params.name The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1957,7 +2040,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -2092,7 +2175,7 @@ export namespace healthcare_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. - * @param {string} params.parent The name of the project whose datasets should be listed (e.g., `projects/{project_id}/locations/{location_id}`). + * @param {string} params.parent The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2286,7 +2369,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 * @example * * // BEFORE RUNNING: * // --------------- @@ -2554,7 +2637,7 @@ export namespace healthcare_v1beta1 { */ datasetId?: string; /** - * The name of the project in which the dataset should be created (e.g., `projects/{project_id}/locations/{location_id}`). + * The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. */ parent?: string; @@ -2571,7 +2654,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Source dataset resource name. (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. */ sourceDataset?: string; @@ -2588,7 +2671,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the dataset to delete (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. */ name?: string; } @@ -2600,7 +2683,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the dataset to read (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. */ name?: string; } @@ -2612,7 +2695,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** @@ -2636,7 +2719,7 @@ export namespace healthcare_v1beta1 { */ pageToken?: string; /** - * The name of the project whose datasets should be listed (e.g., `projects/{project_id}/locations/{location_id}`). + * The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. */ parent?: string; } @@ -2832,6 +2915,81 @@ 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)). + * @alias healthcare.projects.locations.datasets.dicomStores.deidentify + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.sourceStore Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * @param {().DeidentifyDicomStoreRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deidentify( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Deidentify, + options?: MethodOptions + ): GaxiosPromise; + deidentify( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Deidentify, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deidentify( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Deidentify, + callback: BodyResponseCallback + ): void; + deidentify(callback: BodyResponseCallback): void; + deidentify( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dicomstores$Deidentify + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Deidentify; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Deidentify; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+sourceStore}:deidentify').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['sourceStore'], + pathParams: ['sourceStore'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * healthcare.projects.locations.datasets.dicomStores.delete * @desc Deletes the specified DICOM store and removes all images that are contained within it. @@ -3002,7 +3160,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The DICOM store resource name from which the data should be exported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.name The DICOM store resource name from which to export the data. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {().ExportDicomDataRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3241,7 +3399,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -3309,7 +3467,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.import - * @desc Imports data into the DICOM store by copying it from the specified source. For errors, the Operation will be populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which will hold finer-grained error information. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). The metadata field type is OperationMetadata. + * @desc Imports data into the DICOM store by copying it from the specified source. For errors, the Operation is populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which hold finer-grained error information. Errors are also logged to Stackdriver Logging. For more information, see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The metadata field type is OperationMetadata. * @example * * // BEFORE RUNNING: * // --------------- @@ -3365,7 +3523,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the DICOM store resource into which the data is imported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.name The name of the DICOM store resource into which the data is imported. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {().ImportDicomDataRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3499,7 +3657,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. + * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported. For example, `labels.key=value`. * @param {integer=} params.pageSize Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used. * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. * @param {string} params.parent Name of the dataset. @@ -3755,8 +3913,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3878,8 +4036,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4000,8 +4158,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForStudies DICOMweb request (e.g., `studies`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the SearchForStudies DICOMweb request. For example, `studies`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4067,7 +4225,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 * @example * * // BEFORE RUNNING: * // --------------- @@ -4251,8 +4409,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4472,6 +4630,23 @@ export namespace healthcare_v1beta1 { */ requestBody?: Schema$DicomStore; } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Deidentify + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + */ + sourceStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeidentifyDicomStoreRequest; + } export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete extends StandardParameters { /** @@ -4492,7 +4667,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The DICOM store resource name from which the data should be exported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The DICOM store resource name from which to export the data. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ name?: string; @@ -4521,7 +4696,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** @@ -4537,7 +4712,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the DICOM store resource into which the data is imported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store resource into which the data is imported. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ name?: string; @@ -4554,7 +4729,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported. For example, `labels.key=value`. */ filter?: string; /** @@ -4599,11 +4774,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). + * The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -4615,11 +4790,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). + * The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -4631,11 +4806,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the SearchForStudies DICOMweb request (e.g., `studies`). + * The path of the SearchForStudies DICOMweb request. For example, `studies`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -4664,11 +4839,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. + * The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; @@ -4759,8 +4934,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DeleteStudy request (e.g., `studies/{study_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the DeleteStudy request. For example, `studies/{study_uid}`. + * @param {string} params.parent * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4882,8 +5057,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveStudyMetadata DICOMweb request (e.g., `studies/{study_id}/metadata`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5005,8 +5180,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveStudy DICOMweb request (e.g., `studies/{study_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5129,8 +5304,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5252,8 +5427,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5379,8 +5554,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {().HttpBody} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5454,11 +5629,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DeleteStudy request (e.g., `studies/{study_id}`). + * The path of the DeleteStudy request. For example, `studies/{study_uid}`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * */ parent?: string; } @@ -5470,11 +5645,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveStudyMetadata DICOMweb request (e.g., `studies/{study_id}/metadata`). + * The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -5486,11 +5661,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveStudy DICOMweb request (e.g., `studies/{study_id}`). + * The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -5502,11 +5677,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). + * The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -5518,11 +5693,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the SearchForSeries DICOMweb request(e.g., `series` or `studies/{study_uid}/series`). + * The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -5534,11 +5709,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the StoreInstances DICOMweb request (e.g., `studies/[{study_id}]`). Note that the `study_uid` is optional. + * The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; @@ -5613,8 +5788,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DeleteSeries request (e.g., `studies/{study_id}/series/{series_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5736,8 +5911,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveSeriesMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/metadata`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5859,8 +6034,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveSeries DICOMweb request (e.g., `studies/{study_id}/series/{series_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5983,8 +6158,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6057,11 +6232,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DeleteSeries request (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6073,11 +6248,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveSeriesMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/metadata`). + * The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6089,11 +6264,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveSeries DICOMweb request (e.g., `studies/{study_id}/series/{series_id}`). + * The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6105,11 +6280,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the SearchForInstancesRequest DICOMweb request (e.g., `instances` or `series/{series_uid}/instances` or `studies/{study_uid}/instances`). + * The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6179,8 +6354,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the DeleteInstance request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6302,8 +6477,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6425,8 +6600,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveInstanceMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6548,8 +6723,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveRenderedInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6622,11 +6797,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the DeleteInstance request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6638,11 +6813,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}`). + * The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6654,11 +6829,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveInstanceMetadata DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata`). + * The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6670,11 +6845,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveRenderedInstance DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/rendered`). + * The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6743,8 +6918,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6866,8 +7041,8 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.dicomWebPath The path of the RetrieveRenderedFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). - * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {string} params.dicomWebPath The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. + * @param {string} params.parent The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6940,11 +7115,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}`). + * The path of the RetrieveFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -6956,11 +7131,11 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The path of the RetrieveRenderedFrames DICOMweb request (e.g., `studies/{study_id}/series/{series_id}/instances/{instance_id}/frames/{frame_list}/rendered`). + * The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. */ dicomWebPath?: string; /** - * The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. */ parent?: string; } @@ -7101,6 +7276,81 @@ 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)). + * @alias healthcare.projects.locations.datasets.fhirStores.deidentify + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.sourceStore Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * @param {().DeidentifyFhirStoreRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deidentify( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Deidentify, + options?: MethodOptions + ): GaxiosPromise; + deidentify( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Deidentify, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deidentify( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Deidentify, + callback: BodyResponseCallback + ): void; + deidentify(callback: BodyResponseCallback): void; + deidentify( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Deidentify + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Deidentify; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Deidentify; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+sourceStore}:deidentify').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['sourceStore'], + pathParams: ['sourceStore'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * healthcare.projects.locations.datasets.fhirStores.delete * @desc Deletes the specified FHIR store and removes all resources within it. @@ -7511,7 +7761,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -7579,7 +7829,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.import - * @desc Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except for the special case of `history`, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. If history imports are enabled by setting enable_history_import in the FHIR store's configuration, this method can import historical versions of a resource by supplying a bundle of type `history` and using the `BUNDLE` format. The historical versions in the bundle must have `lastUpdated` timestamps, and the resulting resource history on the server will appear as if the versions had been created at those timestamps. If a current or historical version with the supplied resource ID already exists, the bundle is rejected to avoid creating an inconsistent sequence of resource versions. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + * @desc Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @example * * // BEFORE RUNNING: * // --------------- @@ -7969,7 +8219,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 * @example * * // BEFORE RUNNING: * // --------------- @@ -8246,6 +8496,23 @@ export namespace healthcare_v1beta1 { */ requestBody?: Schema$FhirStore; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Deidentify + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + sourceStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeidentifyFhirStoreRequest; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete extends StandardParameters { /** @@ -8295,7 +8562,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** @@ -9330,8 +9597,9 @@ export namespace healthcare_v1beta1 { * @param {string=} params.at Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z` * @param {integer=} params.count The maximum number of search results on a page. Defaults to 1000. * @param {string} params.name The name of the resource to retrieve. - * @param {string=} params.page Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. + * @param {string=} params.page DEPRECATED! Use `_page_token`. * @param {string=} params.since Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. + * @param {string=} params._page_token Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9398,7 +9666,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](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn). Search terms are provided as query parameters following the same pattern as the search method. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation [Observation-lastn](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn). Search terms are provided as query parameters following the same pattern as the search method. 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: * // --------------- @@ -9636,7 +9904,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything - * @desc Retrieves all the resources directly referenced by a patient, as well as all of the resources in the patient compartment. Implements the FHIR extended operation [Patient-everything](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc 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: * // --------------- @@ -9988,7 +10256,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](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the [FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. 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](http://hl7.org/implement/standards/fhir/STU3/http.html#search) using the search semantics described in the [FHIR Search specification](http://hl7.org/implement/standards/fhir/STU3/search.html). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates the search parameters that are supported on each FHIR resource. For the list of search parameters for STU3, see the [STU3 FHIR Search Parameter Registry](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html). Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. 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: * // --------------- @@ -10486,13 +10754,17 @@ export namespace healthcare_v1beta1 { */ name?: string; /** - * Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of the `link.url` field returned in the response to the previous request, where `link.relation` is "first", "previous", "next" or "last". Omit `page` if no previous request has been made. + * DEPRECATED! Use `_page_token`. */ page?: string; /** * Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone. */ since?: string; + /** + * Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. + */ + _page_token?: string; } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Observationlastn extends StandardParameters { @@ -11041,7 +11313,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * @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. @@ -11173,7 +11445,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. + * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported. For example, `labels.key=value`. * @param {integer=} params.pageSize Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used. * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. * @param {string} params.parent Name of the dataset. @@ -11372,7 +11644,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 * @example * * // BEFORE RUNNING: * // --------------- @@ -11681,7 +11953,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; /** @@ -11697,7 +11969,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. + * Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported. For example, `labels.key=value`. */ filter?: string; /** @@ -12064,7 +12336,7 @@ export namespace healthcare_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The resource name of the HL7v2 message to retrieve. - * @param {string=} params.view Specifies which parts of the Message resource should be returned in the response. + * @param {string=} params.view Specifies which parts of the Message resource to return in the 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 @@ -12319,7 +12591,7 @@ export namespace healthcare_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * `message_type`, from the MSH-9 segment; for example `NOT message_type = "ADT"` * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example `send_date < "2017-01-02"` * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example `send_time < "2017-01-02T00:00:00-05:00"` * `send_facility`, the care center that the message came from, from the MSH-4 segment; for example `send_facility = "ABC"` * `HL7RegExp(expr)`, which does regular expression matching of `expr` against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example `HL7RegExp("^.*\|.*\|EMERG")` * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example `PatientId("123456", "MRN")` * `labels.x`, a string value of the label with key `x` as set using the Message.labels map, for example `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label, for example `labels."priority":*`. Limitations on conjunctions: * Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple patient ID functions is not supported, for example this query is invalid: `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * Conjunction of multiple labels fields is also not supported, for example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. + * @param {string=} params.filter Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * `message_type`, from the MSH-9 segment. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label. For example, `labels."priority":*`. Limitations on conjunctions: * Negation on the patient ID function or the labels field is not supported. For example, these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple patient ID functions is not supported, for example this query is invalid: `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * Conjunction of multiple labels fields is also not supported, for example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * Conjunction of one patient ID function, one labels field and conditions on other fields is supported. For example, this query is valid: `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. * @param {string=} params.orderBy Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * `send_time` * @param {integer=} params.pageSize Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. @@ -12453,7 +12725,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 will be merged with the existing set of labels. Existing labels with the same keys will be 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 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 {().Message} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -12558,7 +12830,7 @@ export namespace healthcare_v1beta1 { */ name?: string; /** - * Specifies which parts of the Message resource should be returned in the response. + * Specifies which parts of the Message resource to return in the response. */ view?: string; } @@ -12587,7 +12859,7 @@ export namespace healthcare_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * `message_type`, from the MSH-9 segment; for example `NOT message_type = "ADT"` * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example `send_date < "2017-01-02"` * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example `send_time < "2017-01-02T00:00:00-05:00"` * `send_facility`, the care center that the message came from, from the MSH-4 segment; for example `send_facility = "ABC"` * `HL7RegExp(expr)`, which does regular expression matching of `expr` against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example `HL7RegExp("^.*\|.*\|EMERG")` * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example `PatientId("123456", "MRN")` * `labels.x`, a string value of the label with key `x` as set using the Message.labels map, for example `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label, for example `labels."priority":*`. Limitations on conjunctions: * Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple patient ID functions is not supported, for example this query is invalid: `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * Conjunction of multiple labels fields is also not supported, for example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. + * Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * `message_type`, from the MSH-9 segment. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label. For example, `labels."priority":*`. Limitations on conjunctions: * Negation on the patient ID function or the labels field is not supported. For example, these queries are invalid: `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, `NOT labels."tag2"="val2"`. * Conjunction of multiple patient ID functions is not supported, for example this query is invalid: `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. * Conjunction of multiple labels fields is also not supported, for example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. * Conjunction of one patient ID function, one labels field and conditions on other fields is supported. For example, this query is valid: `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. */ filter?: string; /** @@ -12619,7 +12891,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 will be merged with the existing set of labels. Existing labels with the same keys will be updated. + * 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. */ updateMask?: string; diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index b7620426ae2..90c7c3ffd16 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -204,7 +204,7 @@ export namespace iam_v1 { */ action?: string | null; /** - * The condition that is associated with this binding. This field is logged only for Cloud Audit Logging. + * The condition that is associated with this binding. */ condition?: Schema$Expr; /** @@ -351,7 +351,7 @@ export namespace iam_v1 { */ severity?: string | null; /** - * The validation unit name, for instance “lintValidationUnits/ConditionComplexityCheck”. + * The validation unit name, for instance "lintValidationUnits/ConditionComplexityCheck". */ validationUnitName?: string | null; } @@ -410,16 +410,13 @@ export namespace iam_v1 { */ customRolesSupportLevel?: string | null; /** - * A brief description of what this Permission is used for. + * A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles. */ description?: string | null; /** * The name of this Permission. */ name?: string | null; - /** - * This permission can ONLY be used in predefined roles. - */ onlyInPredefinedRoles?: boolean | null; /** * The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission. @@ -448,7 +445,7 @@ export namespace iam_v1 { removedPermissions?: string[] | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -456,15 +453,15 @@ export namespace iam_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -642,6 +639,10 @@ export namespace iam_v1 { * The key origin. */ keyOrigin?: string | null; + /** + * The key type. + */ + keyType?: string | null; /** * The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. */ diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 0a31ae908a6..aafc0f55779 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -117,6 +117,32 @@ export namespace iap_v1 { } } + /** + * Access related settings for IAP protected apps. + */ + export interface Schema$AccessSettings { + /** + * Configuration to allow cross-origin requests via IAP. + */ + corsSettings?: Schema$CorsSettings; + /** + * GCIP claims and endpoint configurations for 3p identity providers. + */ + gcipSettings?: Schema$GcipSettings; + /** + * Settings to configure IAP's OAuth behavior. + */ + oauthSettings?: Schema$OAuthSettings; + } + /** + * Wrapper over application specific settings for IAP. + */ + export interface Schema$ApplicationSettings { + /** + * Settings to configure IAP's behavior for a CSM mesh. + */ + csmSettings?: Schema$CsmSettings; + } /** * Associates `members` with a `role`. */ @@ -134,6 +160,24 @@ export namespace iap_v1 { */ role?: string | null; } + /** + * Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. + */ + export interface Schema$CorsSettings { + /** + * Configuration to allow HTTP OPTIONS calls to skip authorization. If undefined, IAP will not apply any special logic to OPTIONS requests. + */ + allowHttpOptions?: boolean | null; + } + /** + * Configuration for RCTokens generated for CSM workloads protected by IAP. RCTokens are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for ISTIO deployments, and can be scoped to a single mesh by configuring the audience field accordingly + */ + export interface Schema$CsmSettings { + /** + * Audience claim set in the generated RCToken. This value is not validated by IAP. + */ + rctokenAud?: 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" */ @@ -155,6 +199,19 @@ export namespace iap_v1 { */ title?: string | null; } + /** + * Allows customers to configure tenant_id for GCIP instance per-app. + */ + export interface Schema$GcipSettings { + /** + * Login page URI associated with the GCIP tenants. Typically, all resources within the same project share the same login page, though it could be overridden at the sub resource level. + */ + loginPageUri?: string | null; + /** + * GCIP tenant ids that are linked to the IAP resource. tenant_ids could be a string beginning with a number character to indicate authenticating with GCIP tenant flow, or in the format of _<ProjectNumber> to indicate authenticating with GCIP agent flow. If agent flow is used, tenant_ids should only contain one single element, while for tenant flow, tenant_ids can contain multiple elements. + */ + tenantIds?: string[] | null; + } /** * Request message for `GetIamPolicy` method. */ @@ -174,19 +231,45 @@ export namespace iap_v1 { requestedPolicyVersion?: number | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * The IAP configurable settings. + */ + export interface Schema$IapSettings { + /** + * Top level wrapper for all access related setting in IAP + */ + accessSettings?: Schema$AccessSettings; + /** + * Top level wrapper for all application related settings in IAP + */ + applicationSettings?: Schema$ApplicationSettings; + /** + * Required. The resource name of the IAP protected resource. + */ + name?: string | null; + } + /** + * Configuration for OAuth login&consent flow behavior. + */ + export interface Schema$OAuthSettings { + /** + * 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. + */ + loginHint?: 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -296,6 +379,80 @@ export namespace iap_v1 { } } + /** + * iap.getIapSettings + * @desc Gets the IAP settings on a particular IAP protected resource. + * @alias iap.getIapSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name for which to retrieve the settings. Authorization: Requires the `getSettings` permission for the associated 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 + */ + getIapSettings( + params?: Params$Resource$V1$Getiapsettings, + options?: MethodOptions + ): GaxiosPromise; + getIapSettings( + params: Params$Resource$V1$Getiapsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIapSettings( + params: Params$Resource$V1$Getiapsettings, + callback: BodyResponseCallback + ): void; + getIapSettings(callback: BodyResponseCallback): void; + getIapSettings( + paramsOrCallback?: + | Params$Resource$V1$Getiapsettings + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$V1$Getiapsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$V1$Getiapsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:iapSettings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * iap.setIamPolicy * @desc Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api @@ -449,6 +606,82 @@ export namespace iap_v1 { return createAPIRequest(parameters); } } + + /** + * iap.updateIapSettings + * @desc Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the `update_mask` is set. + * @alias iap.updateIapSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the IAP protected resource. + * @param {string=} params.updateMask The field mask specifying which IAP settings should be updated. If omitted, the all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * @param {().IapSettings} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + updateIapSettings( + params?: Params$Resource$V1$Updateiapsettings, + options?: MethodOptions + ): GaxiosPromise; + updateIapSettings( + params: Params$Resource$V1$Updateiapsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateIapSettings( + params: Params$Resource$V1$Updateiapsettings, + callback: BodyResponseCallback + ): void; + updateIapSettings(callback: BodyResponseCallback): void; + updateIapSettings( + paramsOrCallback?: + | Params$Resource$V1$Updateiapsettings + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$V1$Updateiapsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$V1$Updateiapsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:iapSettings').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$V1$Getiampolicy extends StandardParameters { @@ -467,6 +700,18 @@ export namespace iap_v1 { */ requestBody?: Schema$GetIamPolicyRequest; } + export interface Params$Resource$V1$Getiapsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name for which to retrieve the settings. Authorization: Requires the `getSettings` permission for the associated resource. + */ + name?: string; + } export interface Params$Resource$V1$Setiampolicy extends StandardParameters { /** * Auth client or API Key for the request @@ -500,4 +745,25 @@ export namespace iap_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } + export interface Params$Resource$V1$Updateiapsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the IAP protected resource. + */ + name?: string; + /** + * The field mask specifying which IAP settings should be updated. If omitted, the all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IapSettings; + } } diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index bdfe35b812a..e9e9546e841 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -174,19 +174,19 @@ export namespace iap_v1beta1 { requestedPolicyVersion?: number | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } diff --git a/src/apis/index.ts b/src/apis/index.ts index 9616ad827a9..1d17c87765d 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -115,6 +115,7 @@ import * as kgsearch from './kgsearch'; import * as language from './language'; import * as libraryagent from './libraryagent'; import * as licensing from './licensing'; +import * as lifesciences from './lifesciences'; import * as logging from './logging'; import * as manufacturers from './manufacturers'; import * as mirror from './mirror'; @@ -127,9 +128,11 @@ 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 proximitybeacon from './proximitybeacon'; 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'; @@ -152,6 +155,7 @@ import * as slides from './slides'; import * as sourcerepo from './sourcerepo'; import * as spanner from './spanner'; import * as speech from './speech'; +import * as sql from './sql'; import * as sqladmin from './sqladmin'; import * as storage from './storage'; import * as storagetransfer from './storagetransfer'; @@ -164,7 +168,6 @@ import * as texttospeech from './texttospeech'; import * as toolresults from './toolresults'; import * as tpu from './tpu'; import * as translate from './translate'; -import * as urlshortener from './urlshortener'; import * as vault from './vault'; import * as verifiedaccess from './verifiedaccess'; import * as videointelligence from './videointelligence'; @@ -284,6 +287,7 @@ export const APIS: APIList = { language: language.VERSIONS, libraryagent: libraryagent.VERSIONS, licensing: licensing.VERSIONS, + lifesciences: lifesciences.VERSIONS, logging: logging.VERSIONS, manufacturers: manufacturers.VERSIONS, mirror: mirror.VERSIONS, @@ -296,9 +300,11 @@ export const APIS: APIList = { playcustomapp: playcustomapp.VERSIONS, plus: plus.VERSIONS, plusDomains: plusDomains.VERSIONS, + policytroubleshooter: policytroubleshooter.VERSIONS, poly: poly.VERSIONS, proximitybeacon: proximitybeacon.VERSIONS, pubsub: pubsub.VERSIONS, + recommender: recommender.VERSIONS, redis: redis.VERSIONS, remotebuildexecution: remotebuildexecution.VERSIONS, replicapool: replicapool.VERSIONS, @@ -321,6 +327,7 @@ export const APIS: APIList = { sourcerepo: sourcerepo.VERSIONS, spanner: spanner.VERSIONS, speech: speech.VERSIONS, + sql: sql.VERSIONS, sqladmin: sqladmin.VERSIONS, storage: storage.VERSIONS, storagetransfer: storagetransfer.VERSIONS, @@ -333,7 +340,6 @@ export const APIS: APIList = { toolresults: toolresults.VERSIONS, tpu: tpu.VERSIONS, translate: translate.VERSIONS, - urlshortener: urlshortener.VERSIONS, vault: vault.VERSIONS, verifiedaccess: verifiedaccess.VERSIONS, videointelligence: videointelligence.VERSIONS, @@ -451,6 +457,7 @@ export class GeneratedAPIs { language = language.language; libraryagent = libraryagent.libraryagent; licensing = licensing.licensing; + lifesciences = lifesciences.lifesciences; logging = logging.logging; manufacturers = manufacturers.manufacturers; mirror = mirror.mirror; @@ -463,9 +470,11 @@ export class GeneratedAPIs { playcustomapp = playcustomapp.playcustomapp; plus = plus.plus; plusDomains = plusDomains.plusDomains; + policytroubleshooter = policytroubleshooter.policytroubleshooter; poly = poly.poly; proximitybeacon = proximitybeacon.proximitybeacon; pubsub = pubsub.pubsub; + recommender = recommender.recommender; redis = redis.redis; remotebuildexecution = remotebuildexecution.remotebuildexecution; replicapool = replicapool.replicapool; @@ -489,6 +498,7 @@ export class GeneratedAPIs { sourcerepo = sourcerepo.sourcerepo; spanner = spanner.spanner; speech = speech.speech; + sql = sql.sql; sqladmin = sqladmin.sqladmin; storage = storage.storage; storagetransfer = storagetransfer.storagetransfer; @@ -501,7 +511,6 @@ export class GeneratedAPIs { toolresults = toolresults.toolresults; tpu = tpu.tpu; translate = translate.translate; - urlshortener = urlshortener.urlshortener; vault = vault.vault; verifiedaccess = verifiedaccess.verifiedaccess; videointelligence = videointelligence.videointelligence; diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts index 7c032af25b3..2e790616db8 100644 --- a/src/apis/jobs/v2.ts +++ b/src/apis/jobs/v2.ts @@ -1219,6 +1219,15 @@ export namespace jobs_v2 { */ searchTextSnippet?: string | null; } + /** + * Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2 + */ + export interface Schema$MendelDebugInput { + /** + * When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details. + */ + namespacedDebugInput?: {[key: string]: Schema$NamespacedDebugInput} | null; + } /** * Represents an amount of money with its currency type. */ @@ -1236,6 +1245,67 @@ export namespace jobs_v2 { */ units?: string | null; } + /** + * Next ID: 15 + */ + export interface Schema$NamespacedDebugInput { + /** + * Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions. + */ + absolutelyForcedExpNames?: string[] | null; + /** + * Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions. + */ + absolutelyForcedExps?: number[] | null; + /** + * Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions. + */ + absolutelyForcedExpTags?: string[] | null; + /** + * Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExpNames?: string[] | null; + /** + * Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExps?: number[] | null; + /** + * Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExpTags?: string[] | null; + /** + * If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments. + */ + disableAutomaticEnrollmentSelection?: boolean | null; + /** + * Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together. + */ + disableExpNames?: string[] | null; + /** + * Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together. + */ + disableExps?: number[] | null; + /** + * Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. + */ + disableExpTags?: string[] | null; + /** + * If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments. + */ + disableManualEnrollmentSelection?: boolean | null; + /** + * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. + */ + disableOrganicSelection?: boolean | null; + /** + * Flags to force in a particular experiment state. Map from flag name to flag value. + */ + forcedFlags?: {[key: string]: string} | null; + /** + * Rollouts to force in a particular experiment state. Map from rollout name to rollout value. + */ + forcedRollouts?: {[key: string]: boolean} | null; + } /** * Input only. Use this field to specify bucketing option for the histogram search response. */ diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index e452db126e7..b557ff999b9 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -787,6 +787,10 @@ export namespace jobs_v3 { * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. */ query?: string | null; + /** + * The language code of query. For example, "en-US". This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). + */ + queryLanguageCode?: 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. @@ -906,6 +910,15 @@ export namespace jobs_v3 { */ searchTextSnippet?: string | null; } + /** + * Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2 + */ + export interface Schema$MendelDebugInput { + /** + * When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details. + */ + namespacedDebugInput?: {[key: string]: Schema$NamespacedDebugInput} | null; + } /** * Represents an amount of money with its currency type. */ @@ -923,6 +936,67 @@ export namespace jobs_v3 { */ units?: string | null; } + /** + * Next ID: 15 + */ + export interface Schema$NamespacedDebugInput { + /** + * Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions. + */ + absolutelyForcedExpNames?: string[] | null; + /** + * Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions. + */ + absolutelyForcedExps?: number[] | null; + /** + * Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions. + */ + absolutelyForcedExpTags?: string[] | null; + /** + * Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExpNames?: string[] | null; + /** + * Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExps?: number[] | null; + /** + * Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExpTags?: string[] | null; + /** + * If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments. + */ + disableAutomaticEnrollmentSelection?: boolean | null; + /** + * Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together. + */ + disableExpNames?: string[] | null; + /** + * Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together. + */ + disableExps?: number[] | null; + /** + * Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. + */ + disableExpTags?: string[] | null; + /** + * If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments. + */ + disableManualEnrollmentSelection?: boolean | null; + /** + * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. + */ + disableOrganicSelection?: boolean | null; + /** + * Flags to force in a particular experiment state. Map from flag name to flag value. + */ + forcedFlags?: {[key: string]: string} | null; + /** + * Rollouts to force in a particular experiment state. Map from rollout name to rollout value. + */ + forcedRollouts?: {[key: string]: boolean} | null; + } /** * Input only. Use this field to specify bucketing option for the histogram search response. */ diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index a0561f486c0..d42c5bf3fd1 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -826,6 +826,10 @@ export namespace jobs_v3p1beta1 { * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. */ query?: string | null; + /** + * The language code of query. For example, "en-US". This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). + */ + queryLanguageCode?: 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. @@ -945,6 +949,15 @@ export namespace jobs_v3p1beta1 { */ searchTextSnippet?: string | null; } + /** + * Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2 + */ + export interface Schema$MendelDebugInput { + /** + * When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details. + */ + namespacedDebugInput?: {[key: string]: Schema$NamespacedDebugInput} | null; + } /** * Represents an amount of money with its currency type. */ @@ -962,6 +975,67 @@ export namespace jobs_v3p1beta1 { */ units?: string | null; } + /** + * Next ID: 15 + */ + export interface Schema$NamespacedDebugInput { + /** + * Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions. + */ + absolutelyForcedExpNames?: string[] | null; + /** + * Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions. + */ + absolutelyForcedExps?: number[] | null; + /** + * Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions. + */ + absolutelyForcedExpTags?: string[] | null; + /** + * Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExpNames?: string[] | null; + /** + * Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExps?: number[] | null; + /** + * Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExpTags?: string[] | null; + /** + * If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments. + */ + disableAutomaticEnrollmentSelection?: boolean | null; + /** + * Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together. + */ + disableExpNames?: string[] | null; + /** + * Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together. + */ + disableExps?: number[] | null; + /** + * Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. + */ + disableExpTags?: string[] | null; + /** + * If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments. + */ + disableManualEnrollmentSelection?: boolean | null; + /** + * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. + */ + disableOrganicSelection?: boolean | null; + /** + * Flags to force in a particular experiment state. Map from flag name to flag value. + */ + forcedFlags?: {[key: string]: string} | null; + /** + * Rollouts to force in a particular experiment state. Map from rollout name to rollout value. + */ + forcedRollouts?: {[key: string]: boolean} | null; + } /** * Input only. Use this field to specify bucketing option for the histogram search response. */ diff --git a/src/apis/licensing/README.md b/src/apis/licensing/README.md index d45ca0cc97a..05ee7b5b5b5 100644 --- a/src/apis/licensing/README.md +++ b/src/apis/licensing/README.md @@ -2,7 +2,7 @@ # licensing -> Views and manages licenses for your domain. +> Licensing API to view and manage licenses for your domain ## Installation diff --git a/src/apis/licensing/v1.ts b/src/apis/licensing/v1.ts index ad574ada3e8..903420e76c5 100644 --- a/src/apis/licensing/v1.ts +++ b/src/apis/licensing/v1.ts @@ -73,9 +73,9 @@ export namespace licensing_v1 { } /** - * Enterprise License Manager API + * Licensing API * - * Views and manages licenses for your domain. + * Licensing API to view and manage licenses for your domain * * @example * const {google} = require('googleapis'); @@ -102,7 +102,7 @@ export namespace licensing_v1 { } /** - * Template for LiscenseAssignment Resource + * Representation of a license assignment. */ export interface Schema$LicenseAssignment { /** @@ -114,7 +114,7 @@ export namespace licensing_v1 { */ kind?: string | null; /** - * Id of the product. + * A product's unique identifier. For more information about products in this version of the API, see Product and SKU IDs. */ productId?: string | null; /** @@ -126,7 +126,7 @@ export namespace licensing_v1 { */ selfLink?: string | null; /** - * Id of the sku of the product. + * A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. */ skuId?: string | null; /** @@ -134,12 +134,12 @@ export namespace licensing_v1 { */ skuName?: string | null; /** - * Email id of the user. + * The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. */ userId?: string | null; } /** - * Template for LicenseAssignment Insert request + * Representation of a license assignment. */ export interface Schema$LicenseAssignmentInsert { /** @@ -164,7 +164,7 @@ export namespace licensing_v1 { */ kind?: string | null; /** - * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + * The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The maxResults query string is related to the nextPageToken since maxResults determines how many entries are returned on each next page. */ nextPageToken?: string | null; } @@ -177,14 +177,14 @@ export namespace licensing_v1 { /** * licensing.licenseAssignments.delete - * @desc Revoke License. + * @desc Revoke a license. * @alias licensing.licenseAssignments.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.productId Name for product - * @param {string} params.skuId Name for sku - * @param {string} params.userId email id or unique Id of the user + * @param {string} params.productId A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. + * @param {string} params.skuId A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. + * @param {string} params.userId The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -251,14 +251,14 @@ export namespace licensing_v1 { /** * licensing.licenseAssignments.get - * @desc Get license assignment of a particular product and sku for a user + * @desc Get a specific user's license by product SKU. * @alias licensing.licenseAssignments.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.productId Name for product - * @param {string} params.skuId Name for sku - * @param {string} params.userId email id or unique Id of the user + * @param {string} params.productId A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. + * @param {string} params.skuId A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. + * @param {string} params.userId The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -327,13 +327,13 @@ export namespace licensing_v1 { /** * licensing.licenseAssignments.insert - * @desc Assign License. + * @desc Assign a license. * @alias licensing.licenseAssignments.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.productId Name for product - * @param {string} params.skuId Name for sku + * @param {string} params.productId A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. + * @param {string} params.skuId A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. * @param {().LicenseAssignmentInsert} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -403,15 +403,15 @@ export namespace licensing_v1 { /** * licensing.licenseAssignments.listForProduct - * @desc List license assignments for given product of the customer. + * @desc List all users assigned licenses for a specific product SKU. * @alias licensing.licenseAssignments.listForProduct * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customerId CustomerId represents the customer for whom licenseassignments are queried - * @param {integer=} params.maxResults Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100. - * @param {string=} params.pageToken Token to fetch the next page.Optional. By default server will return first page - * @param {string} params.productId Name for product + * @param {string} params.customerId Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error. + * @param {integer=} params.maxResults The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number. + * @param {string=} params.pageToken Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page. + * @param {string} params.productId A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -483,16 +483,16 @@ export namespace licensing_v1 { /** * licensing.licenseAssignments.listForProductAndSku - * @desc List license assignments for given product and sku of the customer. + * @desc List all users assigned licenses for a specific product SKU. * @alias licensing.licenseAssignments.listForProductAndSku * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.customerId CustomerId represents the customer for whom licenseassignments are queried - * @param {integer=} params.maxResults Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100. - * @param {string=} params.pageToken Token to fetch the next page.Optional. By default server will return first page - * @param {string} params.productId Name for product - * @param {string} params.skuId Name for sku + * @param {string} params.customerId Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error. + * @param {integer=} params.maxResults The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number. + * @param {string=} params.pageToken Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page. + * @param {string} params.productId A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. + * @param {string} params.skuId A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -565,14 +565,14 @@ export namespace licensing_v1 { /** * licensing.licenseAssignments.patch - * @desc Assign License. This method supports patch semantics. + * @desc Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics. * @alias licensing.licenseAssignments.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.productId Name for product - * @param {string} params.skuId Name for sku for which license would be revoked - * @param {string} params.userId email id or unique Id of the user + * @param {string} params.productId A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. + * @param {string} params.skuId A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. + * @param {string} params.userId The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. * @param {().LicenseAssignment} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -642,14 +642,14 @@ export namespace licensing_v1 { /** * licensing.licenseAssignments.update - * @desc Assign License. + * @desc Reassign a user's product SKU with a different SKU in the same product. * @alias licensing.licenseAssignments.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.productId Name for product - * @param {string} params.skuId Name for sku for which license would be revoked - * @param {string} params.userId email id or unique Id of the user + * @param {string} params.productId A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. + * @param {string} params.skuId A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. + * @param {string} params.userId The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. * @param {().LicenseAssignment} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -726,15 +726,15 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name for product + * A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. */ productId?: string; /** - * Name for sku + * A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. */ skuId?: string; /** - * email id or unique Id of the user + * The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. */ userId?: string; } @@ -746,15 +746,15 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name for product + * A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. */ productId?: string; /** - * Name for sku + * A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. */ skuId?: string; /** - * email id or unique Id of the user + * The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. */ userId?: string; } @@ -766,11 +766,11 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name for product + * A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. */ productId?: string; /** - * Name for sku + * A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. */ skuId?: string; @@ -787,19 +787,19 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * CustomerId represents the customer for whom licenseassignments are queried + * Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error. */ customerId?: string; /** - * Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100. + * The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number. */ maxResults?: number; /** - * Token to fetch the next page.Optional. By default server will return first page + * Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page. */ pageToken?: string; /** - * Name for product + * A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. */ productId?: string; } @@ -811,23 +811,23 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * CustomerId represents the customer for whom licenseassignments are queried + * Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error. */ customerId?: string; /** - * Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100. + * The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number. */ maxResults?: number; /** - * Token to fetch the next page.Optional. By default server will return first page + * Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page. */ pageToken?: string; /** - * Name for product + * A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. */ productId?: string; /** - * Name for sku + * A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. */ skuId?: string; } @@ -839,15 +839,15 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name for product + * A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. */ productId?: string; /** - * Name for sku for which license would be revoked + * A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. */ skuId?: string; /** - * email id or unique Id of the user + * The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. */ userId?: string; @@ -864,15 +864,15 @@ export namespace licensing_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name for product + * A product's unique identifier. For more information about products in this version of the API, see Products and SKUs. */ productId?: string; /** - * Name for sku for which license would be revoked + * A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs. */ skuId?: string; /** - * email id or unique Id of the user + * The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes. */ userId?: string; diff --git a/src/apis/lifesciences/README.md b/src/apis/lifesciences/README.md new file mode 100644 index 00000000000..15f7dfd00d3 --- /dev/null +++ b/src/apis/lifesciences/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# lifesciences + +> Cloud Life Sciences is a suite of services and tools for managing, processing, and transforming life sciences data. + +## 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/lifesciences +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/lifesciences.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/lifesciences/index.ts b/src/apis/lifesciences/index.ts new file mode 100644 index 00000000000..b5bd097ae64 --- /dev/null +++ b/src/apis/lifesciences/index.ts @@ -0,0 +1,37 @@ +// 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 {lifesciences_v2beta} from './v2beta'; + +export const VERSIONS = { + v2beta: lifesciences_v2beta.Lifesciences, +}; + +export function lifesciences( + version: 'v2beta' +): lifesciences_v2beta.Lifesciences; +export function lifesciences( + options: lifesciences_v2beta.Options +): lifesciences_v2beta.Lifesciences; +export function lifesciences( + this: GoogleConfigurable, + versionOrOptions: 'v2beta' | lifesciences_v2beta.Options +) { + return getAPI('lifesciences', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/urlshortener/package.json b/src/apis/lifesciences/package.json similarity index 93% rename from src/apis/urlshortener/package.json rename to src/apis/lifesciences/package.json index 472e21fcda9..d28a4d845d6 100644 --- a/src/apis/urlshortener/package.json +++ b/src/apis/lifesciences/package.json @@ -1,7 +1,7 @@ { - "name": "@google/urlshortener", + "name": "@google/lifesciences", "version": "0.1.0", - "description": "urlshortener", + "description": "lifesciences", "main": "build/index.js", "types": "build/index.d.ts", "keywords": [ diff --git a/src/apis/urlshortener/tsconfig.json b/src/apis/lifesciences/tsconfig.json similarity index 100% rename from src/apis/urlshortener/tsconfig.json rename to src/apis/lifesciences/tsconfig.json diff --git a/src/apis/lifesciences/v2beta.ts b/src/apis/lifesciences/v2beta.ts new file mode 100644 index 00000000000..5cce707215f --- /dev/null +++ b/src/apis/lifesciences/v2beta.ts @@ -0,0 +1,1303 @@ +/** + * 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 lifesciences_v2beta { + export interface Options extends GlobalOptions { + version: 'v2beta'; + } + + 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 Life Sciences API + * + * Cloud Life Sciences is a suite of services and tools for managing, processing, and transforming life sciences data. + * + * @example + * const {google} = require('googleapis'); + * const lifesciences = google.lifesciences('v2beta'); + * + * @namespace lifesciences + * @type {Function} + * @version v2beta + * @variation v2beta + * @param {object=} options Options for Lifesciences + */ + export class Lifesciences { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Carries information about an accelerator that can be attached to a VM. + */ + export interface Schema$Accelerator { + /** + * How many accelerators of this type to attach. + */ + count?: string | null; + /** + * The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under `/usr/local/nvidia`. The driver version to install must be specified using the NVIDIA driver version parameter on the virtual machine specification. Note that attaching a GPU increases the worker VM startup time by a few minutes. + */ + type?: string | null; + } + /** + * Specifies a single action that runs a Docker container. + */ + export interface Schema$Action { + /** + * By default, after an action fails, no further actions are run. This flag indicates that this action must be run even if the pipeline has already failed. This is useful for actions that copy output files off of the VM or for debugging. Note that no actions will be run if image prefetching fails. + */ + alwaysRun?: boolean | null; + /** + * If specified, overrides the `CMD` specified in the container. If the container also has an `ENTRYPOINT` the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container. + */ + commands?: string[] | null; + /** + * An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen. + */ + containerName?: string | null; + /** + * If the specified image is hosted on a private registry other than Google Container Registry, the credentials required to pull the image must be specified here as an encrypted secret. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys. + */ + credentials?: Schema$Secret; + /** + * All container images are typically downloaded before any actions are executed. This helps prevent typos in URIs or issues like lack of disk space from wasting large amounts of compute resources. If set, this flag prevents the worker from downloading the image until just before the action is executed. + */ + disableImagePrefetch?: boolean | null; + /** + * A small portion of the container's standard error stream is typically captured and returned inside the `ContainerStoppedEvent`. Setting this flag disables this functionality. + */ + disableStandardErrorCapture?: boolean | null; + /** + * Enable access to the FUSE device for this action. Filesystems can then be mounted into disks shared with other actions. The other actions do not need the `enable_fuse` flag to access the mounted filesystem. This has the effect of causing the container to be executed with `CAP_SYS_ADMIN` and exposes `/dev/fuse` to the container, so use it only for containers you trust. + */ + enableFuse?: boolean | null; + /** + * If specified, overrides the `ENTRYPOINT` specified in the container. + */ + entrypoint?: string | null; + /** + * The environment to pass into the container. This environment is merged with values specified in the google.cloud.lifesciences.v2beta.Pipeline message, overwriting any duplicate values. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed. + */ + environment?: {[key: string]: string} | null; + /** + * Normally, a non-zero exit status causes the pipeline to fail. This flag allows execution of other actions to continue instead. + */ + ignoreExitStatus?: boolean | null; + /** + * Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases. If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.cloud.lifesciences.v2beta.Action.credentials field. + */ + imageUri?: string | null; + /** + * Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored. + */ + labels?: {[key: string]: string} | null; + /** + * A list of mounts to make available to the action. In addition to the values specified here, every action has a special virtual disk mounted under `/google` that contains log files and other operational components. <ul> <li><code>/google/logs</code> All logs written during the pipeline execution.</li> <li><code>/google/logs/output</code> The combined standard output and standard error of all actions run as part of the pipeline execution.</li> <li><code>/google/logs/action/x/stdout</code> The complete contents of each individual action's standard output.</li> <li><code>/google/logs/action/x/stderr</code> The complete contents of each individual action's standard error output.</li> </ul> + */ + mounts?: Schema$Mount[]; + /** + * An optional identifier for a PID namespace to run the action inside. Multiple actions should use the same string to share a namespace. If unspecified, a separate isolated namespace is used. + */ + pidNamespace?: string | null; + /** + * A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the `ContainerStartedEvent` in the operation metadata. + */ + portMappings?: {[key: string]: number} | null; + /** + * Exposes all ports specified by `EXPOSE` statements in the container. To discover the host side port numbers, consult the `ACTION_STARTED` event in the operation metadata. + */ + publishExposedPorts?: boolean | null; + /** + * This flag allows an action to continue running in the background while executing subsequent actions. This is useful to provide services to other actions (or to provide debugging support tools like SSH servers). + */ + runInBackground?: boolean | null; + /** + * The maximum amount of time to give the action to complete. If the action fails to complete before the timeout, it will be terminated and the exit status will be non-zero. The pipeline will continue or terminate based on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. + */ + timeout?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user. + */ + export interface Schema$ContainerKilledEvent { + /** + * The numeric ID of the action that started the container. + */ + actionId?: number | null; + } + /** + * An event generated when a container starts. + */ + export interface Schema$ContainerStartedEvent { + /** + * The numeric ID of the action that started this container. + */ + actionId?: number | null; + /** + * The public IP address that can be used to connect to the container. This field is only populated when at least one port mapping is present. If the instance was created with a private address, this field will be empty even if port mappings exist. + */ + ipAddress?: string | null; + /** + * The container-to-host port mappings installed for this container. This set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` definition. + */ + portMappings?: {[key: string]: number} | null; + } + /** + * An event generated when a container exits. + */ + export interface Schema$ContainerStoppedEvent { + /** + * The numeric ID of the action that started this container. + */ + actionId?: number | null; + /** + * The exit status of the container. + */ + exitStatus?: number | null; + /** + * The tail end of any content written to standard error by the container. If the content emits large amounts of debugging noise or contains sensitive information, you can prevent the content from being printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end of the stream is captured here. The entire stream is stored in the `/google/logs` directory mounted into each action, and can be copied off the machine as described elsewhere. + */ + stderr?: string | null; + } + /** + * An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run. + */ + export interface Schema$DelayedEvent { + /** + * A textual description of the cause of the delay. The string can change without notice because it is often generated by another service (such as Compute Engine). + */ + cause?: string | null; + /** + * If the delay was caused by a resource shortage, this field lists the Compute Engine metrics that are preventing this operation from running (for example, `CPUS` or `INSTANCES`). If the particular metric is not known, a single `UNKNOWN` metric will be present. + */ + metrics?: string[] | null; + } + /** + * Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations. + */ + export interface Schema$Disk { + /** + * A user-supplied name for the disk. Used when mounting the disk into actions. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen. + */ + name?: string | null; + /** + * The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance. + */ + sizeGb?: number | null; + /** + * An optional image to put on the disk before attaching it to the VM. + */ + sourceImage?: string | null; + /** + * The Compute Engine disk type. If unspecified, `pd-standard` is used. + */ + type?: 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 {} + /** + * Carries information about events that occur during pipeline execution. + */ + export interface Schema$Event { + /** + * See google.cloud.lifesciences.v2beta.ContainerKilledEvent. + */ + containerKilled?: Schema$ContainerKilledEvent; + /** + * See google.cloud.lifesciences.v2beta.ContainerStartedEvent. + */ + containerStarted?: Schema$ContainerStartedEvent; + /** + * See google.cloud.lifesciences.v2beta.ContainerStoppedEvent. + */ + containerStopped?: Schema$ContainerStoppedEvent; + /** + * See google.cloud.lifesciences.v2beta.DelayedEvent. + */ + delayed?: Schema$DelayedEvent; + /** + * A human-readable description of the event. Note that these strings can change at any time without notice. Any application logic must use the information in the `details` field. + */ + description?: string | null; + /** + * See google.cloud.lifesciences.v2beta.FailedEvent. + */ + failed?: Schema$FailedEvent; + /** + * See google.cloud.lifesciences.v2beta.PullStartedEvent. + */ + pullStarted?: Schema$PullStartedEvent; + /** + * See google.cloud.lifesciences.v2beta.PullStoppedEvent. + */ + pullStopped?: Schema$PullStoppedEvent; + /** + * The time at which the event occurred. + */ + timestamp?: string | null; + /** + * See google.cloud.lifesciences.v2beta.UnexpectedExitStatusEvent. + */ + unexpectedExitStatus?: Schema$UnexpectedExitStatusEvent; + /** + * See google.cloud.lifesciences.v2beta.WorkerAssignedEvent. + */ + workerAssigned?: Schema$WorkerAssignedEvent; + /** + * See google.cloud.lifesciences.v2beta.WorkerReleasedEvent. + */ + workerReleased?: Schema$WorkerReleasedEvent; + } + /** + * An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event. + */ + export interface Schema$FailedEvent { + /** + * The human-readable description of the cause of the failure. + */ + cause?: string | null; + /** + * The Google standard error code that best describes this failure. + */ + code?: 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; + } + /** + * Carries information about the pipeline execution that is returned in the long running operation's metadata field. + */ + export interface Schema$Metadata { + /** + * The time at which the operation was created by the API. + */ + createTime?: string | null; + /** + * The time at which execution was completed and resources were cleaned up. + */ + endTime?: string | null; + /** + * The list of events that have happened so far during the execution of this operation. + */ + events?: Schema$Event[]; + /** + * The user-defined labels associated with this operation. + */ + labels?: {[key: string]: string} | null; + /** + * The pipeline this operation represents. + */ + pipeline?: Schema$Pipeline; + /** + * The first time at which resources were allocated to execute the pipeline. + */ + startTime?: string | null; + } + /** + * Carries information about a particular disk mount inside a container. + */ + export interface Schema$Mount { + /** + * The name of the disk to mount, as specified in the resources section. + */ + disk?: string | null; + /** + * The path to mount the disk inside the container. + */ + path?: string | null; + /** + * If true, the disk is mounted read-only inside the container. + */ + readOnly?: boolean | null; + } + /** + * VM networking options. + */ + export interface Schema$Network { + /** + * The network name to attach the VM's network interface to. The value will be prefixed with `global/networks/` unless it contains a `/`, in which case it is assumed to be a fully specified network resource URL. If unspecified, the global default network is used. + */ + network?: string | null; + /** + * If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here. The value is prefixed with `regions/x/subnetworks/` unless it contains a `/`, in which case it is assumed to be a fully specified subnetwork resource URL. If the `*` character appears in the value, it is replaced with the region that the virtual machine has been allocated in. + */ + subnetwork?: string | null; + /** + * If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information. + */ + usePrivateAddress?: boolean | 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; + /** + * An Metadata object. This will always be returned with the Operation. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status. + */ + name?: string | null; + /** + * An Empty object. + */ + response?: {[key: string]: any} | null; + } + /** + * Specifies a series of actions to execute, expressed as Docker containers. + */ + export interface Schema$Pipeline { + /** + * The list of actions to execute, in the order they are specified. + */ + actions?: Schema$Action[]; + /** + * The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value). + */ + environment?: {[key: string]: string} | null; + /** + * The resources required for execution. + */ + resources?: Schema$Resources; + /** + * The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. + */ + timeout?: string | null; + } + /** + * An event generated when the worker starts pulling an image. + */ + export interface Schema$PullStartedEvent { + /** + * The URI of the image that was pulled. + */ + imageUri?: string | null; + } + /** + * An event generated when the worker stops pulling an image. + */ + export interface Schema$PullStoppedEvent { + /** + * The URI of the image that was pulled. + */ + imageUri?: string | null; + } + /** + * The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail. + */ + export interface Schema$Resources { + /** + * The list of regions allowed for VM allocation. If set, the `zones` field must not be set. + */ + regions?: string[] | null; + /** + * The virtual machine specification. + */ + virtualMachine?: Schema$VirtualMachine; + /** + * The list of zones allowed for VM allocation. If set, the `regions` field must not be set. + */ + zones?: string[] | null; + } + /** + * The arguments to the `RunPipeline` method. The requesting user must have the `iam.serviceAccounts.actAs` permission for the Cloud Life Sciences service account or the request will fail. + */ + export interface Schema$RunPipelineRequest { + /** + * User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, `VirtualMachine`). + */ + labels?: {[key: string]: string} | null; + /** + * Required. The description of the pipeline to run. + */ + pipeline?: Schema$Pipeline; + } + /** + * The response to the RunPipeline method, returned in the operation's result field on success. + */ + export interface Schema$RunPipelineResponse {} + /** + * Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline. + */ + export interface Schema$Secret { + /** + * The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited. + */ + cipherText?: string | null; + /** + * The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key. + */ + keyName?: string | null; + } + /** + * Carries information about a Google Cloud service account. + */ + export interface Schema$ServiceAccount { + /** + * Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. + */ + email?: string | null; + /** + * List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default. + */ + scopes?: 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; + } + /** + * An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped. + */ + export interface Schema$UnexpectedExitStatusEvent { + /** + * The numeric ID of the action that started the container. + */ + actionId?: number | null; + /** + * The exit status of the container. + */ + exitStatus?: number | null; + } + /** + * Carries information about a Compute Engine VM resource. + */ + export interface Schema$VirtualMachine { + /** + * The list of accelerators to attach to the VM. + */ + accelerators?: Schema$Accelerator[]; + /** + * The size of the boot disk, in GB. The boot disk must be large enough to accommodate all of the Docker images from each action in the pipeline at the same time. If not specified, a small but reasonable default value is used. + */ + bootDiskSizeGb?: number | null; + /** + * The host operating system image to use. Currently, only Container-Optimized OS images can be used. The default value is `projects/cos-cloud/global/images/family/cos-stable`, which selects the latest stable release of Container-Optimized OS. This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines. To test a pipeline against the beta release of Container-Optimized OS, use the value `projects/cos-cloud/global/images/family/cos-beta`. + */ + bootImage?: string | null; + /** + * The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + */ + cpuPlatform?: string | null; + /** + * The list of disks to create and attach to the VM. + */ + disks?: Schema$Disk[]; + /** + * Whether Stackdriver monitoring should be enabled on the VM. + */ + enableStackdriverMonitoring?: boolean | null; + /** + * Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the [name and value restrictions](https://cloud.google.com/compute/docs/labeling-resources) on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The machine type of the virtual machine to create. Must be the short name of a standard machine type (such as "n1-standard-1") or a custom machine type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "4096" indicates the memory in MB). See [Creating an instance with a custom machine type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create) for more specifications on creating a custom machine type. + */ + machineType?: string | null; + /** + * The VM network configuration. + */ + network?: Schema$Network; + /** + * The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The version specified here must be compatible with the GPU libraries contained in the container being executed, and must be one of the drivers hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage. + */ + nvidiaDriverVersion?: string | null; + /** + * If true, allocate a preemptible VM. + */ + preemptible?: boolean | null; + /** + * The service account to install on the VM. This account does not need any permissions other than those required by the pipeline. + */ + serviceAccount?: Schema$ServiceAccount; + } + /** + * An event generated after a worker VM has been assigned to run the pipeline. + */ + export interface Schema$WorkerAssignedEvent { + /** + * The worker's instance name. + */ + instance?: string | null; + /** + * The machine type that was assigned for the worker. + */ + machineType?: string | null; + /** + * The zone the worker is running in. + */ + zone?: string | null; + } + /** + * An event generated when the worker VM that was assigned to the pipeline has been released (deleted). + */ + export interface Schema$WorkerReleasedEvent { + /** + * The worker's instance name. + */ + instance?: string | null; + /** + * The zone the worker was running in. + */ + zone?: 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); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; + pipelines: Resource$Projects$Locations$Pipelines; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.pipelines = new Resource$Projects$Locations$Pipelines(this.context); + } + + /** + * lifesciences.projects.locations.get + * @desc Gets information about a location. + * @alias lifesciences.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://lifesciences.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * lifesciences.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias lifesciences.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://lifesciences.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * lifesciences.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. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.cancel` + * @alias lifesciences.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.resource Request body data + * @param {object} [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://lifesciences.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+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); + } + } + + /** + * lifesciences.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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.get` + * @alias lifesciences.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://lifesciences.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * lifesciences.projects.locations.operations.list + * @desc Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.list` + * @alias lifesciences.projects.locations.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A string for filtering Operations. The following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The maximum number of results to return. The maximum value is 256. + * @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://lifesciences.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+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; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + 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; + + /** + * A string for filtering Operations. The following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The maximum number of results to return. The maximum value is 256. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Pipelines { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * lifesciences.projects.locations.pipelines.run + * @desc Runs a pipeline. The returned Operation's metadata field will contain a google.cloud.lifesciences.v2beta.Metadata object describing the status of the pipeline execution. The response field will contain a google.cloud.lifesciences.v2beta.RunPipelineResponse object if the pipeline completes successfully. **Note:** Before you can use this method, the *Life Sciences Service Agent* must have access to your project. This is done automatically when the Cloud Life Sciences API is first enabled, but if you delete this permission you must disable and re-enable the API to grant the Life Sciences Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `lifesciences.workflows.run` + * @alias lifesciences.projects.locations.pipelines.run + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project and location that this request should be executed against. + * @param {().RunPipelineRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + run( + params?: Params$Resource$Projects$Locations$Pipelines$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Pipelines$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Pipelines$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pipelines$Run + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pipelines$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pipelines$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://lifesciences.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+parent}/pipelines:run').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$Pipelines$Run + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project and location that this request should be executed against. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunPipelineRequest; + } +} diff --git a/src/apis/urlshortener/webpack.config.js b/src/apis/lifesciences/webpack.config.js similarity index 96% rename from src/apis/urlshortener/webpack.config.js rename to src/apis/lifesciences/webpack.config.js index 18d0c8ec19d..4088806f9d2 100644 --- a/src/apis/urlshortener/webpack.config.js +++ b/src/apis/lifesciences/webpack.config.js @@ -24,8 +24,8 @@ module.exports = { extensions: ['.ts', '.js', '.json'], }, output: { - library: 'Urlshortener', - filename: 'urlshortener.min.js', + library: 'Lifesciences', + filename: 'lifesciences.min.js', path: path.resolve(__dirname, 'dist'), }, node: { diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index c986c77c4c8..8ac21a06fcb 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -308,7 +308,7 @@ export namespace logging_v2 { */ export interface Schema$ListLogEntriesRequest { /** - * Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters. + * Optional. A filter that chooses which log entries to return. See Advanced Logs Queries. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters. */ filter?: string | null; /** @@ -619,6 +619,10 @@ export namespace logging_v2 { * Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks. */ destination?: string | null; + /** + * Do not use. This field is ignored. + */ + endTime?: string | null; /** * Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR */ @@ -635,6 +639,10 @@ export namespace logging_v2 { * Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed. */ outputVersionFormat?: string | null; + /** + * Do not use. This field is ignored. + */ + startTime?: string | null; /** * Output only. The last update timestamp of the sink.This field may not be present for older sinks. */ @@ -672,6 +680,10 @@ export namespace logging_v2 { * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. */ metricKind?: string | null; + /** + * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. + */ + monitoredResourceTypes?: string[] | null; /** * The resource name of the metric descriptor. */ @@ -698,7 +710,7 @@ export namespace logging_v2 { */ ingestDelay?: string | null; /** - * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. + * Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: string | null; /** @@ -1439,7 +1451,7 @@ export namespace logging_v2 { /** * 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. + * @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! () * @@ -3269,7 +3281,7 @@ export namespace logging_v2 { /** * 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. + * @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! () * @@ -4006,7 +4018,7 @@ export namespace logging_v2 { /** * 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. + * @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! () * @@ -4769,7 +4781,7 @@ export namespace logging_v2 { /** * 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. + * @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! () * @@ -5977,7 +5989,7 @@ export namespace logging_v2 { /** * logging.projects.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. + * @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.projects.logs.delete * @memberOf! () * diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 98903b427fc..1d8616178e8 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -89,7 +89,7 @@ export namespace ml_v1 { } /** - * Cloud Machine Learning Engine + * AI Platform Training & Prediction API * * An API to enable creating and using machine learning models. * @@ -148,7 +148,7 @@ export namespace ml_v1 { trainingStep?: string | null; } /** - * Represents a hardware accelerator request config. + * Represents a hardware accelerator request config. Note that the AcceleratorConfig can be used in both Jobs and Versions. Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus). */ export interface Schema$GoogleCloudMlV1__AcceleratorConfig { /** @@ -165,7 +165,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__AutoScaling { /** - * Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least `rate` * `min_nodes` * number of hours since last billing cycle, where `rate` is the cost per node-hour as documented in the [pricing guide](/ml-engine/docs/pricing), even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at least `min_nodes`. You will be charged for the time in which additional nodes are used. If not specified, `min_nodes` defaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. You can set `min_nodes` when creating the model version, and you can also update `min_nodes` for an existing version: <pre> update_body.json: { 'autoScaling': { 'minNodes': 5 } } </pre> HTTP request: <pre> PATCH https://ml.googleapis.com/v1/{name=projects/x/models/x/versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json </pre> + * Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least `rate` * `min_nodes` * number of hours since last billing cycle, where `rate` is the cost per node-hour as documented in the [pricing guide](/ml-engine/docs/pricing), even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at least `min_nodes`. You will be charged for the time in which additional nodes are used. If `min_nodes` is not specified and AutoScaling is used with a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. If `min_nodes` is not specified and AutoScaling is used with a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 1. `min_nodes` must be at least 1 for use with a Compute Engine machine type. Note that you cannot use AutoScaling if your version uses [GPUs](#Version.FIELDS.accelerator_config). Instead, you must use ManualScaling. You can set `min_nodes` when creating the model version, and you can also update `min_nodes` for an existing version: <pre> update_body.json: { 'autoScaling': { 'minNodes': 5 } } </pre> HTTP request: <pre style="max-width: 626px;"> PATCH https://ml.googleapis.com/v1/{name=projects/x/models/x/versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json </pre> */ minNodes?: number | null; } @@ -709,6 +709,10 @@ export namespace ml_v1 { * Required. Specifies the machine types, the number of replicas for workers and parameter servers. */ scaleTier?: string | null; + /** + * Optional. Use 'chief' instead of 'master' in TF_CONFIG when Custom Container is used and evaluator is not specified. Defaults to false. + */ + useChiefInTfConfig?: boolean | null; /** * Optional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ml-engine/docs/tensorflow/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ml-engine/docs/distributed-training-containers). */ @@ -760,7 +764,11 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__Version { /** - * Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes. + * Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the `machineType` field. Learn more about [using GPUs for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus). + */ + acceleratorConfig?: Schema$GoogleCloudMlV1__AcceleratorConfig; + /** + * Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes. Note that you cannot use AutoScaling if your version uses [GPUs](#Version.FIELDS.accelerator_config). Instead, you must use specify `manual_scaling`. */ autoScaling?: Schema$GoogleCloudMlV1__AutoScaling; /** @@ -784,7 +792,7 @@ export namespace ml_v1 { */ etag?: string | null; /** - * Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ml-engine/docs/tensorflow/custom-prediction-routines). + * Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction) in the `machineType` field, you must specify `TENSORFLOW` for the framework. */ framework?: string | null; /** @@ -800,7 +808,7 @@ export namespace ml_v1 { */ lastUseTime?: string | null; /** - * Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. <dl> <dt>mls1-c1-m2</dt> <dd> The <b>default</b> machine type, with 1 core and 2 GB RAM. The deprecated name for this machine type is "mls1-highmem-1". </dd> <dt>mls1-c4-m2</dt> <dd> In <b>Beta</b>. This machine type has 4 cores and 2 GB RAM. The deprecated name for this machine type is "mls1-highcpu-4". </dd> </dl> + * Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. If this field is not specified, it defaults to `mls1-c1-m2`. Online prediction supports the following machine types: * `mls1-c1-m2` * `mls1-c4-m2` * `n1-standard-2` * `n1-standard-4` * `n1-standard-8` * `n1-standard-16` * `n1-standard-32` * `n1-highmem-2` * `n1-highmem-4` * `n1-highmem-8` * `n1-highmem-16` * `n1-highmem-32` * `n1-highcpu-2` * `n1-highcpu-4` * `n1-highcpu-8` * `n1-highcpu-16` * `n1-highcpu-32` `mls1-c1-m2` is generally available. All other machine types are available in beta. Learn more about the [differences between machine types](/ml-engine/docs/machine-types-online-prediction). */ machineType?: string | null; /** @@ -816,7 +824,7 @@ export namespace ml_v1 { */ packageUris?: string[] | null; /** - * Optional. The fully qualified name (<var>module_name</var>.<var>class_name</var>) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. The following code sample provides the Predictor interface: ```py class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() ``` Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). + * Optional. The fully qualified name (<var>module_name</var>.<var>class_name</var>) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: <pre style="max-width: 626px;"> class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() </pre> Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). */ predictionClass?: string | null; /** @@ -884,7 +892,7 @@ export namespace ml_v1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$GoogleIamV1__Policy { /** @@ -892,15 +900,15 @@ export namespace ml_v1 { */ auditConfigs?: Schema$GoogleIamV1__AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -1681,7 +1689,7 @@ export namespace ml_v1 { /** * ml.projects.jobs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 ml.projects.jobs.setIamPolicy * @memberOf! () * @@ -2687,7 +2695,7 @@ export namespace ml_v1 { /** * ml.projects.models.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 ml.projects.models.setIamPolicy * @memberOf! () * @@ -3337,7 +3345,7 @@ export namespace ml_v1 { * * @param {object} params Parameters for request * @param {string} params.name Required. The name of the model. - * @param {string=} params.updateMask Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo" } Currently the only supported update mask fields are `description` and `autoScaling.minNodes`. + * @param {string=} params.updateMask Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction). * @param {().GoogleCloudMlV1__Version} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3568,7 +3576,7 @@ export namespace ml_v1 { */ name?: string; /** - * Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo" } Currently the only supported update mask fields are `description` and `autoScaling.minNodes`. + * Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: ``` { "description": "foo" } ``` Currently the only supported update mask fields are `description`, `autoScaling.minNodes`, and `manualScaling.nodes`. However, you can only update `manualScaling.nodes` if the version uses a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction). */ updateMask?: string; diff --git a/src/apis/monitoring/index.ts b/src/apis/monitoring/index.ts index 59948e284c4..10e76cf13de 100644 --- a/src/apis/monitoring/index.ts +++ b/src/apis/monitoring/index.ts @@ -14,19 +14,27 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {monitoring_v1} from './v1'; import {monitoring_v3} from './v3'; export const VERSIONS = { + v1: monitoring_v1.Monitoring, v3: monitoring_v3.Monitoring, }; +export function monitoring(version: 'v1'): monitoring_v1.Monitoring; +export function monitoring( + options: monitoring_v1.Options +): monitoring_v1.Monitoring; export function monitoring(version: 'v3'): monitoring_v3.Monitoring; export function monitoring( options: monitoring_v3.Options ): monitoring_v3.Monitoring; -export function monitoring( +export function monitoring< + T = monitoring_v1.Monitoring | monitoring_v3.Monitoring +>( this: GoogleConfigurable, - versionOrOptions: 'v3' | monitoring_v3.Options + versionOrOptions: 'v1' | monitoring_v1.Options | 'v3' | monitoring_v3.Options ) { return getAPI('monitoring', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/monitoring/v1.ts b/src/apis/monitoring/v1.ts new file mode 100644 index 00000000000..67f0696c7c0 --- /dev/null +++ b/src/apis/monitoring/v1.ts @@ -0,0 +1,231 @@ +/** + * 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 monitoring_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; + } + + /** + * Stackdriver Monitoring API + * + * Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Stackdriver Monitoring documentation. + * + * @example + * const {google} = require('googleapis'); + * const monitoring = google.monitoring('v1'); + * + * @namespace monitoring + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Monitoring + */ + export class Monitoring { + context: APIRequestContext; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + } + } + + /** + * A set of (label, value) pairs which were dropped during aggregation, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.These values are used in combination with the label values that remain on the aggregated Distribution timeseries to construct the full label set for the exemplar values. The resulting full label set may be used to identify the specific task/job/instance (for example) which may be contributing to a long-tail, while allowing the storage savings of only storing aggregated distribution values for a large group.Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities. + */ + export interface Schema$DroppedLabels { + /** + * Map from label to its value, for all labels dropped in any aggregation. + */ + label?: {[key: string]: string} | null; + } + /** + * A single field of a message type. + */ + export interface Schema$Field { + /** + * The field cardinality. + */ + cardinality?: string | null; + /** + * The string value of the default value of this field. Proto2 syntax only. + */ + defaultValue?: string | null; + /** + * The field JSON name. + */ + jsonName?: string | null; + /** + * The field type. + */ + kind?: string | null; + /** + * The field name. + */ + name?: string | null; + /** + * The field number. + */ + number?: number | null; + /** + * The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. + */ + oneofIndex?: number | null; + /** + * The protocol buffer options. + */ + options?: Schema$Option[]; + /** + * Whether to use alternative packed wire representation. + */ + packed?: boolean | null; + /** + * The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp". + */ + typeUrl?: string | null; + } + /** + * A protocol buffer option, which can be attached to a message, field, enumeration, etc. + */ + export interface Schema$Option { + /** + * The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http". + */ + name?: string | null; + /** + * The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. + */ + value?: {[key: string]: any} | null; + } + /** + * SourceContext represents information about the source of a protobuf element, like the file in which it is defined. + */ + export interface Schema$SourceContext { + /** + * The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto". + */ + fileName?: string | 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 + */ + 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. + */ + spanName?: string | null; + } + /** + * A protocol buffer message type. + */ + export interface Schema$Type { + /** + * The list of fields. + */ + fields?: Schema$Field[]; + /** + * The fully qualified message name. + */ + name?: string | null; + /** + * The list of types appearing in oneof definitions in this type. + */ + oneofs?: string[] | null; + /** + * The protocol buffer options. + */ + options?: Schema$Option[]; + /** + * The source context. + */ + sourceContext?: Schema$SourceContext; + /** + * The source syntax. + */ + syntax?: string | null; + } +} diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 3e3bc3e78f0..5df9ee45bb4 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -637,7 +637,7 @@ export namespace monitoring_v3 { */ description?: string | null; /** - * The label key. + * The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores. */ key?: string | null; /** @@ -822,7 +822,7 @@ export namespace monitoring_v3 { */ export interface Schema$MetricAbsence { /** - * Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. + * Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. */ aggregations?: Schema$Aggregation[]; /** @@ -830,7 +830,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 MetricService.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 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; /** @@ -866,6 +866,10 @@ export namespace monitoring_v3 { * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. */ metricKind?: string | null; + /** + * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. + */ + monitoredResourceTypes?: string[] | null; /** * The resource name of the metric descriptor. */ @@ -892,7 +896,7 @@ export namespace monitoring_v3 { */ ingestDelay?: string | null; /** - * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. + * Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: string | null; /** @@ -905,7 +909,7 @@ export namespace monitoring_v3 { */ export interface Schema$MetricThreshold { /** - * Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. + * Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. */ aggregations?: Schema$Aggregation[]; /** @@ -913,11 +917,11 @@ export namespace monitoring_v3 { */ comparison?: string | null; /** - * Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field. + * Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels. */ 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 is similar to the one that is specified in the MetricService.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 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; /** @@ -925,7 +929,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 MetricService.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 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; /** @@ -1089,7 +1093,7 @@ export namespace monitoring_v3 { */ export interface Schema$Point { /** - * The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. + * The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. */ interval?: Schema$TimeInterval; /** @@ -1172,7 +1176,7 @@ export namespace monitoring_v3 { port?: number | null; } /** - * A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time. For a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. For DELTA and CUMULATIVE metrics, the start time must be earlier than the end time. In all cases, the start time of the next interval must be at least a microsecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time. + * A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. In no case can the end time be earlier than the start time. For a GAUGE metric, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. For DELTA and CUMULATIVE metrics, the start time must be earlier than the end time. In all cases, the start time of the next interval must be at least a microsecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end time. */ export interface Schema$TimeInterval { /** @@ -1300,6 +1304,10 @@ export namespace monitoring_v3 { * The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig. */ internalCheckers?: Schema$InternalChecker[]; + /** + * If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false. + */ + isInternal?: boolean | null; /** * The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for Uptime checks: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer */ @@ -4874,7 +4882,7 @@ export namespace monitoring_v3 { * @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.orderBy Unsupported: must be left blank. The points in each time series are returned in reverse time order. + * @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. @@ -5004,7 +5012,7 @@ export namespace monitoring_v3 { */ name?: string; /** - * Unsupported: must be left blank. The points in each time series are returned in reverse time order. + * Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest). */ orderBy?: string; /** diff --git a/src/apis/oslogin/README.md b/src/apis/oslogin/README.md index 04dc0ee05d1..95f87e1f671 100644 --- a/src/apis/oslogin/README.md +++ b/src/apis/oslogin/README.md @@ -2,7 +2,7 @@ # oslogin -> Manages OS login configuration for Google account users. +> You can use OS Login to manage access to your VM instances using IAM roles. For more information, read [OS Login](/compute/docs/oslogin/). ## Installation diff --git a/src/apis/oslogin/v1.ts b/src/apis/oslogin/v1.ts index 8dc39e86650..f8956690ecd 100644 --- a/src/apis/oslogin/v1.ts +++ b/src/apis/oslogin/v1.ts @@ -135,7 +135,7 @@ export namespace oslogin_v1 { */ export interface Schema$LoginProfile { /** - * A unique user ID. + * Required. A unique user ID. */ name?: string | null; /** @@ -167,6 +167,10 @@ export namespace oslogin_v1 { * The path to the home directory for this account. */ homeDirectory?: string | null; + /** + * Output only. The canonical resource name. + */ + name?: string | null; /** * The operating system type where this account applies. */ @@ -208,6 +212,10 @@ export namespace oslogin_v1 { * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ key?: string | null; + /** + * Output only. The canonical resource name. + */ + name?: string | null; } export class Resource$Users { @@ -227,7 +235,7 @@ export namespace oslogin_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The unique ID for the user in format `users/{user}`. + * @param {string} params.name Required. The unique ID for the user in format `users/{user}`. * @param {string=} params.projectId The project ID of the Google Cloud Platform project. * @param {string=} params.systemId A system ID for filtering the results of the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -303,7 +311,7 @@ export namespace oslogin_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The unique ID for the user in format `users/{user}`. + * @param {string} params.parent Required. The unique ID for the user in format `users/{user}`. * @param {string=} params.projectId The project ID of the Google Cloud Platform project. * @param {().SshPublicKey} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -388,7 +396,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the user in format `users/{user}`. + * Required. The unique ID for the user in format `users/{user}`. */ name?: string; /** @@ -408,7 +416,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the user in format `users/{user}`. + * Required. The unique ID for the user in format `users/{user}`. */ parent?: string; /** @@ -435,7 +443,7 @@ export namespace oslogin_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. + * @param {string} params.name Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/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 @@ -506,7 +514,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. + * Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. */ name?: string; } @@ -524,7 +532,7 @@ export namespace oslogin_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * @param {string} params.name Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -593,7 +601,7 @@ export namespace oslogin_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * @param {string} params.name Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -664,7 +672,7 @@ export namespace oslogin_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * @param {string} params.name Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * @param {string=} params.updateMask Mask to control which fields get updated. Updates all if not present. * @param {().SshPublicKey} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -739,7 +747,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -751,7 +759,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -763,7 +771,7 @@ export namespace oslogin_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; /** diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index a1145e3669c..95fe417123f 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -167,6 +167,10 @@ export namespace oslogin_v1alpha { * The path to the home directory for this account. */ homeDirectory?: string | null; + /** + * Output only. The canonical resource name. + */ + name?: string | null; /** * The operating system type where this account applies. */ @@ -208,6 +212,10 @@ export namespace oslogin_v1alpha { * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ key?: string | null; + /** + * Output only. The canonical resource name. + */ + name?: string | null; } export class Resource$Users { diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index d587755091f..05a858e77dc 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -135,7 +135,7 @@ export namespace oslogin_v1beta { */ export interface Schema$LoginProfile { /** - * A unique user ID. + * Required. A unique user ID. */ name?: string | null; /** @@ -167,6 +167,10 @@ export namespace oslogin_v1beta { * The path to the home directory for this account. */ homeDirectory?: string | null; + /** + * Output only. The canonical resource name. + */ + name?: string | null; /** * The operating system type where this account applies. */ @@ -208,6 +212,10 @@ export namespace oslogin_v1beta { * Public key text in SSH format, defined by <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a> section 6.6. */ key?: string | null; + /** + * Output only. The canonical resource name. + */ + name?: string | null; } export class Resource$Users { @@ -227,7 +235,7 @@ export namespace oslogin_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The unique ID for the user in format `users/{user}`. + * @param {string} params.name Required. The unique ID for the user in format `users/{user}`. * @param {string=} params.projectId The project ID of the Google Cloud Platform project. * @param {string=} params.systemId A system ID for filtering the results of the request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -388,7 +396,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The unique ID for the user in format `users/{user}`. + * Required. The unique ID for the user in format `users/{user}`. */ name?: string; /** @@ -435,7 +443,7 @@ export namespace oslogin_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. + * @param {string} params.name Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/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 @@ -506,7 +514,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. + * Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. */ name?: string; } @@ -524,7 +532,7 @@ export namespace oslogin_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * @param {string} params.name Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -593,7 +601,7 @@ export namespace oslogin_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * @param {string} params.name Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -664,7 +672,7 @@ export namespace oslogin_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * @param {string} params.name Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. * @param {string=} params.updateMask Mask to control which fields get updated. Updates all if not present. * @param {().SshPublicKey} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -739,7 +747,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -751,7 +759,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; } @@ -763,7 +771,7 @@ export namespace oslogin_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. + * Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`. */ name?: string; /** diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index f8448141d15..406d037223f 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -140,7 +140,7 @@ export namespace people_v1 { */ extendedAddress?: string | null; /** - * The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string | null; /** @@ -250,23 +250,23 @@ export namespace people_v1 { */ etag?: string | null; /** - * The read-only name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name. + * Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name. */ formattedName?: string | null; /** - * The read-only contact group type. + * Output only. The contact group type. */ groupType?: string | null; /** - * The total number of contacts in the group irrespective of max members in specified in the request. + * Output only. The total number of contacts in the group irrespective of max members in specified in the request. */ memberCount?: number | null; /** - * The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify). + * Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify). */ memberResourceNames?: string[] | null; /** - * Metadata about the contact group. + * Output only. Metadata about the contact group. */ metadata?: Schema$ContactGroupMetadata; /** @@ -283,7 +283,7 @@ export namespace people_v1 { */ export interface Schema$ContactGroupMembership { /** - * The read-only contact group ID for the contact group membership. + * Output only. The contact group ID for the contact group membership. */ contactGroupId?: string | null; /** @@ -292,15 +292,15 @@ export namespace people_v1 { contactGroupResourceName?: string | null; } /** - * The read-only metadata about a contact group. + * The metadata about a contact group. */ export interface Schema$ContactGroupMetadata { /** - * True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token. + * Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token. */ deleted?: boolean | null; /** - * The time the group was last updated. + * Output only. The time the group was last updated. */ updateTime?: string | null; } @@ -322,7 +322,7 @@ export namespace people_v1 { status?: Schema$Status; } /** - * A person's read-only cover photo. A large image shown on the person's profile page that represents who they are or what they care about. + * A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about. */ export interface Schema$CoverPhoto { /** @@ -343,7 +343,7 @@ export namespace people_v1 { */ export interface Schema$CreateContactGroupRequest { /** - * The contact group to create. + * Required. The contact group to create. */ contactGroup?: Schema$ContactGroup; } @@ -374,7 +374,7 @@ export namespace people_v1 { person?: Schema$Person; } /** - * A read-only G Suite Domain membership. + * A G Suite Domain membership. */ export interface Schema$DomainMembership { /** @@ -391,7 +391,7 @@ export namespace people_v1 { */ displayName?: string | null; /** - * The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string | null; /** @@ -420,7 +420,7 @@ export namespace people_v1 { */ date?: Schema$Date; /** - * The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string | null; /** @@ -445,7 +445,7 @@ export namespace people_v1 { */ source?: Schema$Source; /** - * True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person. + * Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person. */ verified?: boolean | null; } @@ -454,7 +454,7 @@ export namespace people_v1 { */ export interface Schema$Gender { /** - * The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedValue?: string | null; /** @@ -477,11 +477,11 @@ export namespace people_v1 { */ export interface Schema$ImClient { /** - * The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedProtocol?: string | null; /** - * The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string | null; /** @@ -579,7 +579,7 @@ export namespace people_v1 { */ contactGroupMembership?: Schema$ContactGroupMembership; /** - * The read-only domain membership. + * Output only. The domain membership. */ domainMembership?: Schema$DomainMembership; /** @@ -592,11 +592,11 @@ export namespace people_v1 { */ export interface Schema$ModifyContactGroupMembersRequest { /** - * The resource names of the contact people to add in the form of in the form `people/`<var>person_id</var>. + * The resource names of the contact people to add in the form of `people/`<var>person_id</var>. */ resourceNamesToAdd?: string[] | null; /** - * The resource names of the contact people to remove in the form of in the form of `people/`<var>person_id</var>. + * The resource names of the contact people to remove in the form of `people/`<var>person_id</var>. */ resourceNamesToRemove?: string[] | null; } @@ -618,11 +618,11 @@ export namespace people_v1 { */ export interface Schema$Name { /** - * The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. + * Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. */ displayName?: string | null; /** - * The read-only display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. + * Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header. */ displayNameLastFirst?: string | null; /** @@ -725,7 +725,7 @@ export namespace people_v1 { */ endDate?: Schema$Date; /** - * The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string | null; /** @@ -774,11 +774,11 @@ export namespace people_v1 { */ addresses?: Schema$Address[]; /** - * **DEPRECATED** (Please use `person.ageRanges` instead)** The person's read-only age range. + * Output only. **DEPRECATED** (Please use `person.ageRanges` instead)** The person's age range. */ ageRange?: string | null; /** - * The person's read-only age ranges. + * Output only. The person's age ranges. */ ageRanges?: Schema$AgeRangeType[]; /** @@ -794,7 +794,7 @@ export namespace people_v1 { */ braggingRights?: Schema$BraggingRights[]; /** - * The person's read-only cover photos. + * Output only. The person's cover photos. */ coverPhotos?: Schema$CoverPhoto[]; /** @@ -830,7 +830,7 @@ export namespace people_v1 { */ memberships?: Schema$Membership[]; /** - * Read-only metadata about the person. + * Output only. Metadata about the person. */ metadata?: Schema$PersonMetadata; /** @@ -854,7 +854,7 @@ export namespace people_v1 { */ phoneNumbers?: Schema$PhoneNumber[]; /** - * The person's read-only photos. + * Output only. The person's photos. */ photos?: Schema$Photo[]; /** @@ -862,11 +862,11 @@ export namespace people_v1 { */ relations?: Schema$Relation[]; /** - * The person's read-only relationship interests. + * Output only. The person's relationship interests. */ relationshipInterests?: Schema$RelationshipInterest[]; /** - * The person's read-only relationship statuses. + * Output only. The person's relationship statuses. */ relationshipStatuses?: Schema$RelationshipStatus[]; /** @@ -886,7 +886,7 @@ export namespace people_v1 { */ skills?: Schema$Skill[]; /** - * The person's read-only taglines. + * Output only. The person's taglines. */ taglines?: Schema$Tagline[]; /** @@ -899,23 +899,23 @@ export namespace people_v1 { userDefined?: Schema$UserDefined[]; } /** - * The read-only metadata about a person. + * The metadata about a person. */ export interface Schema$PersonMetadata { /** - * True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. + * Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. */ deleted?: boolean | null; /** - * Resource names of people linked to this resource. + * Output only. Resource names of people linked to this resource. */ linkedPeopleResourceNames?: string[] | null; /** - * **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object. + * Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object. */ objectType?: string | null; /** - * Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL. + * Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL. */ previousResourceNames?: string[] | null; /** @@ -949,11 +949,11 @@ export namespace people_v1 { */ export interface Schema$PhoneNumber { /** - * The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number. + * Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number. */ canonicalForm?: string | null; /** - * The read-only type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string | null; /** @@ -970,7 +970,7 @@ export namespace people_v1 { value?: string | null; } /** - * A person's read-only photo. A picture shown next to the person's name to help others recognize the person. + * A person's photo. A picture shown next to the person's name to help others recognize the person. */ export interface Schema$Photo { /** @@ -987,15 +987,15 @@ export namespace people_v1 { url?: string | null; } /** - * The read-only metadata about a profile. + * The metadata about a profile. */ export interface Schema$ProfileMetadata { /** - * The profile object type. + * Output only. The profile object type. */ objectType?: string | null; /** - * The user types. + * Output only. The user types. */ userTypes?: string[] | null; } @@ -1004,7 +1004,7 @@ export namespace people_v1 { */ export interface Schema$Relation { /** - * The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. + * Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. */ formattedType?: string | null; /** @@ -1021,11 +1021,11 @@ export namespace people_v1 { type?: string | null; } /** - * A person's read-only relationship interest . + * A person's relationship interest . */ export interface Schema$RelationshipInterest { /** - * The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. + * Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header. */ formattedValue?: string | null; /** @@ -1038,11 +1038,11 @@ export namespace people_v1 { value?: string | null; } /** - * A person's read-only relationship status. + * A person's relationship status. */ export interface Schema$RelationshipStatus { /** - * The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedValue?: string | null; /** @@ -1076,7 +1076,7 @@ export namespace people_v1 { */ export interface Schema$SipAddress { /** - * The read-only type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string | null; /** @@ -1118,7 +1118,7 @@ export namespace people_v1 { */ id?: string | null; /** - * **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. + * Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE. */ profileMetadata?: Schema$ProfileMetadata; /** @@ -1126,7 +1126,7 @@ export namespace people_v1 { */ type?: string | null; /** - * **Only populated in `person.metadata.sources`.** Last update timestamp of this source. + * Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source. */ updateTime?: string | null; } @@ -1148,7 +1148,7 @@ export namespace people_v1 { message?: string | null; } /** - * A read-only brief one-line description of the person. + * A brief one-line description of the person. */ export interface Schema$Tagline { /** @@ -1165,7 +1165,7 @@ export namespace people_v1 { */ export interface Schema$UpdateContactGroupRequest { /** - * The contact group to update. + * Required. The contact group to update. */ contactGroup?: Schema$ContactGroup; } @@ -1174,11 +1174,11 @@ export namespace people_v1 { */ export interface Schema$UpdateContactPhotoRequest { /** - * **Optional.** Not specifying any fields will skip the post mutate read. 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 + * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. 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 */ personFields?: string | null; /** - * Raw photo bytes + * Required. Raw photo bytes */ photoBytes?: string | null; } @@ -1196,7 +1196,7 @@ export namespace people_v1 { */ export interface Schema$Url { /** - * The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. + * Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. */ formattedType?: string | null; /** @@ -1245,8 +1245,8 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxMembers Specifies the maximum number of members to return for each group. - * @param {string=} params.resourceNames The resource names of the contact groups to get. + * @param {integer=} params.maxMembers Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members. + * @param {string=} params.resourceNames Required. The resource names of the contact groups 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 @@ -1400,8 +1400,8 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.deleteContacts Set to true to also delete the contacts in the specified group. - * @param {string} params.resourceName The resource name of the contact group to delete. + * @param {boolean=} params.deleteContacts Optional. Set to true to also delete the contacts in the specified group. + * @param {string} params.resourceName Required. The resource name of the contact group 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 @@ -1473,8 +1473,8 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.maxMembers Specifies the maximum number of members to return. - * @param {string} params.resourceName The resource name of the contact group to get. + * @param {integer=} params.maxMembers Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members. + * @param {string} params.resourceName Required. The resource name of the contact group 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 @@ -1548,7 +1548,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of resources to return. + * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1705,11 +1705,11 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the maximum number of members to return for each group. + * Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members. */ maxMembers?: number; /** - * The resource names of the contact groups to get. + * Required. The resource names of the contact groups to get. */ resourceNames?: string[]; } @@ -1733,11 +1733,11 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set to true to also delete the contacts in the specified group. + * Optional. Set to true to also delete the contacts in the specified group. */ deleteContacts?: boolean; /** - * The resource name of the contact group to delete. + * Required. The resource name of the contact group to delete. */ resourceName?: string; } @@ -1749,11 +1749,11 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Specifies the maximum number of members to return. + * Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members. */ maxMembers?: number; /** - * The resource name of the contact group to get. + * Required. The resource name of the contact group to get. */ resourceName?: string; } @@ -1765,7 +1765,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of resources to return. + * 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. */ pageSize?: number; /** @@ -1808,7 +1808,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resourceName The resource name of the contact group to modify. + * @param {string} params.resourceName Required. The resource name of the contact group to modify. * @param {().ModifyContactGroupMembersRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1894,7 +1894,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the contact group to modify. + * Required. The resource name of the contact group to modify. */ resourceName?: string; @@ -1919,7 +1919,6 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.parent The resource name of the owning person resource. * @param {().Person} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1992,7 +1991,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resourceName The resource name of the contact to delete. + * @param {string} params.resourceName Required. The resource name of the contact 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 @@ -2064,8 +2063,8 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.personFields **Optional.** Not specifying any fields will skip the post mutate read. 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.resourceName The resource name of the contact whose photo will be deleted. + * @param {string=} params.personFields Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. 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.resourceName Required. The resource name of the contact whose photo will 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 @@ -2146,9 +2145,9 @@ export namespace people_v1 { * @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 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.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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2219,9 +2218,9 @@ export namespace people_v1 { * @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 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.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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2296,7 +2295,7 @@ export namespace people_v1 { * * @param {object} params Parameters for request * @param {string} params.resourceName The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`person_id. - * @param {string=} params.updatePersonFields **Required.** A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * emailAddresses * events * genders * imClients * interests * locales * memberships * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined + * @param {string=} params.updatePersonFields Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * emailAddresses * events * genders * imClients * interests * locales * memberships * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined * @param {().Person} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2369,7 +2368,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resourceName Person resource name + * @param {string} params.resourceName Required. Person resource name * @param {().UpdateContactPhotoRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2452,11 +2451,6 @@ export namespace people_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - /** - * The resource name of the owning person resource. - */ - parent?: string; - /** * Request body metadata */ @@ -2470,7 +2464,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the contact to delete. + * Required. The resource name of the contact to delete. */ resourceName?: string; } @@ -2482,11 +2476,11 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * **Optional.** Not specifying any fields will skip the post mutate read. 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 + * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. 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 */ personFields?: string; /** - * The resource name of the contact whose photo will be deleted. + * Required. The resource name of the contact whose photo will be deleted. */ resourceName?: string; } @@ -2497,15 +2491,15 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * **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 + * 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 */ personFields?: string; /** - * **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`. + * 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`. */ 'requestMask.includeField'?: string; /** - * 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,15 +2511,15 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * **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 + * 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 */ personFields?: string; /** - * **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`. + * 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`. */ 'requestMask.includeField'?: string; /** - * 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[]; } @@ -2541,7 +2535,7 @@ export namespace people_v1 { */ resourceName?: string; /** - * **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 + * 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 */ updatePersonFields?: string; @@ -2558,7 +2552,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Person resource name + * Required. Person resource name */ resourceName?: string; @@ -2581,12 +2575,12 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100. + * @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.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.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 {string} params.resourceName The resource name to return connections for. Only `people/me` is valid. + * @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 {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2666,7 +2660,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100. + * 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. */ pageSize?: number; /** @@ -2674,11 +2668,11 @@ export namespace people_v1 { */ pageToken?: string; /** - * **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 + * 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 */ personFields?: string; /** - * **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`. + * 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`. */ 'requestMask.includeField'?: string; /** @@ -2686,7 +2680,7 @@ export namespace people_v1 { */ requestSyncToken?: boolean; /** - * The resource name to return connections for. Only `people/me` is valid. + * Required. The resource name to return connections for. Only `people/me` is valid. */ resourceName?: string; /** diff --git a/src/apis/urlshortener/README.md b/src/apis/policytroubleshooter/README.md similarity index 82% rename from src/apis/urlshortener/README.md rename to src/apis/policytroubleshooter/README.md index b0d9a4b0e31..df69db34412 100644 --- a/src/apis/urlshortener/README.md +++ b/src/apis/policytroubleshooter/README.md @@ -1,8 +1,8 @@ Google Inc. logo -# urlshortener +# policytroubleshooter -> Lets you create, inspect, and manage goo.gl short 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/urlshortener +$ cd src/apis/policytroubleshooter $ npm install $ npm run webpack ``` -The generated bundle will be written to `dist/urlshortener.min.js`. Use it from your HTML file: +The generated bundle will be written to `dist/policytroubleshooter.min.js`. Use it from your HTML file: ```html - + ``` diff --git a/src/apis/policytroubleshooter/index.ts b/src/apis/policytroubleshooter/index.ts new file mode 100644 index 00000000000..36e57147e3c --- /dev/null +++ b/src/apis/policytroubleshooter/index.ts @@ -0,0 +1,39 @@ +// 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 {policytroubleshooter_v1beta} from './v1beta'; + +export const VERSIONS = { + v1beta: policytroubleshooter_v1beta.Policytroubleshooter, +}; + +export function policytroubleshooter( + version: 'v1beta' +): policytroubleshooter_v1beta.Policytroubleshooter; +export function policytroubleshooter( + options: policytroubleshooter_v1beta.Options +): policytroubleshooter_v1beta.Policytroubleshooter; +export function policytroubleshooter< + T = policytroubleshooter_v1beta.Policytroubleshooter +>( + this: GoogleConfigurable, + versionOrOptions: 'v1beta' | policytroubleshooter_v1beta.Options +) { + return getAPI('policytroubleshooter', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/policytroubleshooter/package.json b/src/apis/policytroubleshooter/package.json new file mode 100644 index 00000000000..b4ed0b96148 --- /dev/null +++ b/src/apis/policytroubleshooter/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/policytroubleshooter", + "version": "0.1.0", + "description": "policytroubleshooter", + "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.15.0", + "typescript": "~3.6.0", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" + } +} diff --git a/src/apis/policytroubleshooter/tsconfig.json b/src/apis/policytroubleshooter/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/policytroubleshooter/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/policytroubleshooter/v1beta.ts b/src/apis/policytroubleshooter/v1beta.ts new file mode 100644 index 00000000000..e9da66d634d --- /dev/null +++ b/src/apis/policytroubleshooter/v1beta.ts @@ -0,0 +1,436 @@ +/** + * 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 policytroubleshooter_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; + } + + /** + * Policy Troubleshooter API + * + * + * + * @example + * const {google} = require('googleapis'); + * const policytroubleshooter = google.policytroubleshooter('v1beta'); + * + * @namespace policytroubleshooter + * @type {Function} + * @version v1beta + * @variation v1beta + * @param {object=} options Options for Policytroubleshooter + */ + export class Policytroubleshooter { + context: APIRequestContext; + iam: Resource$Iam; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.iam = new Resource$Iam(this.context); + } + } + + /** + * AccessTuple defines information required for checking an access attempt. In other words, this is the tuple given to `CheckAccess`. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1betaAccessTuple { + /** + * Required. A full resource name according to https://cloud.google.com/apis/design/resource_names. This is the full resource name of the resource that access is checked against. + */ + fullResourceName?: string | null; + /** + * Required. The Cloud IAM permission under which defines the kind of access being explained. Example: "resourcemanager.projects.get" would explain if and why the principal has the resourcemanager.projects.get permission on the resource specified in full_resource_name declared in this structure. See https://cloud.google.com/iam/docs/testing-permissions + */ + permission?: string | null; + /** + * Required. The principal on behalf of who the access is explained for. The format is one of the principal's email addresses associated with its gaia account. It must be an account that can appear as an actor. For example groups are not supported. Currently, service accounts, users are supported. + */ + principal?: string | null; + } + /** + * Binding Explanation. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1betaBindingExplanation { + /** + * REQUIRED: Access decision for this binding. + */ + access?: string | null; + /** + * The condition which needs to be satisfied in order for this binding to grant the role to the principal. See https://cloud.google.com/iam/docs/conditions-base + */ + condition?: Schema$GoogleTypeExpr; + /** + * For each member in the binding, provides information whether or not the principal from the request is included in the member by which the CheckResult is keyed. May indicate that the caller has no access to this information. example key: 'group:cloud-iam-assist-eng@google.com' example value '{NOT_GRANTED, HIGH} + */ + memberships?: { + [key: string]: Schema$GoogleCloudPolicytroubleshooterV1betaBindingExplanationAnnotatedMembership; + } | null; + /** + * Bubbles up role_permission level relavance to BindingExplanation object. If role permission is NORMAL, then binding relevance is NORMAL. If role permission is HIGH, then binding relevance is HIGH. + */ + relevance?: string | null; + /** + * The role that this binding grants in the policy. for example "roles/compute.serviceAgent" + */ + role?: string | null; + /** + * Whether the role of this binding contains the checked permission + */ + rolePermission?: string | null; + /** + * The relevance of this permission with respect to the BindingExplanation. + */ + rolePermissionRelevance?: string | null; + } + /** + * Encapsulated membership and the relevance of that membership with respect to BindingExplanation. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1betaBindingExplanationAnnotatedMembership { + /** + * Membership status. + */ + membership?: string | null; + /** + * Relevance of this membership with respect to BindingExplanation. + */ + relevance?: string | null; + } + /** + * An explained IAM policy combines the raw policy in the context of the resource which it is attached to along with detailed evaluation on the evaluation parameters provided through the request. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1betaExplainedPolicy { + /** + * Access decision for this section of the resource's effective policy. + */ + access?: string | null; + /** + * Detailed binding evaluation explanations provide information about how each binding contributes to the principal's access or the lack thereof. + */ + bindingExplanations?: Schema$GoogleCloudPolicytroubleshooterV1betaBindingExplanation[]; + /** + * Resource that this section of the effective policy attaches to. + */ + fullResourceName?: string | null; + /** + * The IAM policy attached to the resource. + */ + policy?: Schema$GoogleIamV1Policy; + /** + * Relevance of this Policy. + */ + relevance?: string | null; + } + /** + * TroubleshootIamPolicyRequest is used in TroubleshootIamPolicy + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyRequest { + /** + * Collection of attributes for example user, permission, resource that define troubleshooter's input. + */ + accessTuple?: Schema$GoogleCloudPolicytroubleshooterV1betaAccessTuple; + } + /** + * TroubleshootIamPolicyResponse is used in TroubleshootIamPolicy. + */ + export interface Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse { + /** + * Reflects whether the probed access was granted, denied or ultimately could not be decided from the caller's point of view. + */ + access?: string | null; + /** + * List of explained policies. Each explanation corresponds to one policy along the ancestry path. + */ + explainedPolicies?: Schema$GoogleCloudPolicytroubleshooterV1betaExplainedPolicy[]; + } + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + */ + export interface Schema$GoogleIamV1AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$GoogleIamV1AuditLogConfig[]; + /** + * 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$GoogleIamV1AuditLogConfig { + /** + * 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$GoogleIamV1Binding { + /** + * 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$GoogleTypeExpr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + */ + members?: string[] | null; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: 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). + */ + export interface Schema$GoogleIamV1Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$GoogleIamV1AuditConfig[]; + /** + * 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. + */ + bindings?: Schema$GoogleIamV1Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. 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?: 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 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. + */ + 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" + */ + 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. + */ + 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$Iam { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * policytroubleshooter.iam.troubleshoot + * @desc Perform a check on whether a member is granted a permission on a resource and how that grant/deny is determined accordinga to the resource's effective IAM policy interpretation. + * @alias policytroubleshooter.iam.troubleshoot + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + troubleshoot( + params?: Params$Resource$Iam$Troubleshoot, + options?: MethodOptions + ): GaxiosPromise< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + >; + troubleshoot( + params: Params$Resource$Iam$Troubleshoot, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + > + ): void; + troubleshoot( + params: Params$Resource$Iam$Troubleshoot, + callback: BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + > + ): void; + troubleshoot( + callback: BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + > + ): void; + troubleshoot( + paramsOrCallback?: + | Params$Resource$Iam$Troubleshoot + | BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + > { + let params = (paramsOrCallback || {}) as Params$Resource$Iam$Troubleshoot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Iam$Troubleshoot; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://policytroubleshooter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/iam:troubleshoot').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyResponse + >(parameters); + } + } + } + + export interface Params$Resource$Iam$Troubleshoot extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyRequest; + } +} diff --git a/src/apis/policytroubleshooter/webpack.config.js b/src/apis/policytroubleshooter/webpack.config.js new file mode 100644 index 00000000000..e0bf96249dd --- /dev/null +++ b/src/apis/policytroubleshooter/webpack.config.js @@ -0,0 +1,71 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Policytroubleshooter', + filename: 'policytroubleshooter.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/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 913beb31fae..47ff47cee4a 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -297,19 +297,19 @@ export namespace pubsub_v1 { serviceAccountEmail?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -1323,7 +1323,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 * @example * * // BEFORE RUNNING: * // --------------- @@ -3086,7 +3086,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 * @example * * // BEFORE RUNNING: * // --------------- @@ -4433,7 +4433,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index 428b20fb0da..539bce9eb52 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -247,19 +247,19 @@ export namespace pubsub_v1beta2 { serviceAccountEmail?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -1097,7 +1097,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.subscriptions.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 pubsub.projects.subscriptions.setIamPolicy * @memberOf! () * @@ -1875,7 +1875,7 @@ export namespace pubsub_v1beta2 { /** * pubsub.projects.topics.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 pubsub.projects.topics.setIamPolicy * @memberOf! () * diff --git a/src/apis/recommender/README.md b/src/apis/recommender/README.md new file mode 100644 index 00000000000..c077863f6d8 --- /dev/null +++ b/src/apis/recommender/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# recommender + +> + +## 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/recommender +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/recommender.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/recommender/index.ts b/src/apis/recommender/index.ts new file mode 100644 index 00000000000..f333d159c2e --- /dev/null +++ b/src/apis/recommender/index.ts @@ -0,0 +1,37 @@ +// 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 {recommender_v1beta1} from './v1beta1'; + +export const VERSIONS = { + v1beta1: recommender_v1beta1.Recommender, +}; + +export function recommender( + version: 'v1beta1' +): recommender_v1beta1.Recommender; +export function recommender( + options: recommender_v1beta1.Options +): recommender_v1beta1.Recommender; +export function recommender( + this: GoogleConfigurable, + versionOrOptions: 'v1beta1' | recommender_v1beta1.Options +) { + return getAPI('recommender', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/recommender/package.json b/src/apis/recommender/package.json new file mode 100644 index 00000000000..0d0faf540d1 --- /dev/null +++ b/src/apis/recommender/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/recommender", + "version": "0.1.0", + "description": "recommender", + "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.15.0", + "typescript": "~3.6.0", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" + } +} diff --git a/src/apis/recommender/tsconfig.json b/src/apis/recommender/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/recommender/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/recommender/v1beta1.ts b/src/apis/recommender/v1beta1.ts new file mode 100644 index 00000000000..d287314943d --- /dev/null +++ b/src/apis/recommender/v1beta1.ts @@ -0,0 +1,968 @@ +/** + * 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 recommender_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; + } + + /** + * Recommender API + * + * + * + * @example + * const {google} = require('googleapis'); + * const recommender = google.recommender('v1beta1'); + * + * @namespace recommender + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Recommender + */ + export class Recommender { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Contains metadata about how much money a recommendation can save or incur. + */ + export interface Schema$GoogleCloudRecommenderV1beta1CostProjection { + /** + * An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units. + */ + cost?: Schema$GoogleTypeMoney; + /** + * Duration for which this cost applies. + */ + duration?: string | null; + } + /** + * Contains the impact a recommendation can have for a given category. + */ + export interface Schema$GoogleCloudRecommenderV1beta1Impact { + /** + * Category that is being targeted. + */ + category?: string | null; + /** + * Use with CategoryType.COST + */ + costProjection?: Schema$GoogleCloudRecommenderV1beta1CostProjection; + } + /** + * Response to the `ListRecommendations` method. + */ + export interface Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse { + /** + * A token that can be used to request the next page of results. This field is empty if there are no additional results. + */ + nextPageToken?: string | null; + /** + * The set of recommendations for the `parent` resource. + */ + recommendations?: Schema$GoogleCloudRecommenderV1beta1Recommendation[]; + } + /** + * Request for the `MarkRecommendationClaimed` Method. + */ + export interface Schema$GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest { + /** + * Fingerprint of the Recommendation. Provides optimistic locking. + */ + etag?: string | null; + /** + * State properties to include with this state. Overwrites any existing `state_metadata`. + */ + stateMetadata?: {[key: string]: string} | null; + } + /** + * Request for the `MarkRecommendationFailed` Method. + */ + export interface Schema$GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest { + /** + * Fingerprint of the Recommendation. Provides optimistic locking. + */ + etag?: string | null; + /** + * State properties to include with this state. Overwrites any existing `state_metadata`. + */ + stateMetadata?: {[key: string]: string} | null; + } + /** + * Request for the `MarkRecommendationSucceeded` Method. + */ + export interface Schema$GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest { + /** + * Fingerprint of the Recommendation. Provides optimistic locking. + */ + etag?: string | null; + /** + * State properties to include with this state. Overwrites any existing `state_metadata`. + */ + stateMetadata?: {[key: string]: string} | null; + } + /** + * Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC. + */ + export interface Schema$GoogleCloudRecommenderV1beta1Operation { + /** + * Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated. + */ + action?: string | null; + /** + * Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated. + */ + path?: string | null; + /** + * Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/x/name" : "it-123" "/versions/x/targetSize/percent": 20 } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/condition" : null } * Example: { "/bindings/x/role": "roles/admin" "/bindings/x/members/*" : ["x@google.com", "y@google.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed. + */ + pathFilters?: {[key: string]: any} | null; + /** + * Similar to path_filters, this contains set of filters to apply if `path` field referes to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed. + */ + pathValueMatchers?: { + [key: string]: Schema$GoogleCloudRecommenderV1beta1ValueMatcher; + } | null; + /** + * Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. + */ + resource?: string | null; + /** + * Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance + */ + resourceType?: string | null; + /** + * Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types. + */ + sourcePath?: string | null; + /** + * Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = <source> and resource_name = <target>. This field is empty for all other values of `action`. + */ + sourceResource?: string | null; + /** + * Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed. + */ + value?: any | null; + /** + * Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation. + */ + valueMatcher?: Schema$GoogleCloudRecommenderV1beta1ValueMatcher; + } + /** + * Group of operations that need to be performed atomically. + */ + export interface Schema$GoogleCloudRecommenderV1beta1OperationGroup { + /** + * List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. + */ + operations?: Schema$GoogleCloudRecommenderV1beta1Operation[]; + } + /** + * A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc + */ + export interface Schema$GoogleCloudRecommenderV1beta1Recommendation { + /** + * Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. + */ + additionalImpact?: Schema$GoogleCloudRecommenderV1beta1Impact[]; + /** + * Content of the recommendation describing recommended changes to resources. + */ + content?: Schema$GoogleCloudRecommenderV1beta1RecommendationContent; + /** + * Free-form human readable summary in English. The maximum length is 500 characters. + */ + description?: string | null; + /** + * Fingerprint of the Recommendation. Provides optimistic locking when updating states. + */ + etag?: string | null; + /** + * Last time this recommendation was refreshed by the system that created it in the first place. + */ + lastRefreshTime?: string | null; + /** + * Name of recommendation. A project recommendation is represented as projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + */ + name?: string | null; + /** + * The primary impact that this recommendation can have while trying to optimize for one category. + */ + primaryImpact?: Schema$GoogleCloudRecommenderV1beta1Impact; + /** + * Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" + */ + recommenderSubtype?: string | null; + /** + * Information for state. Contains state and metadata. + */ + stateInfo?: Schema$GoogleCloudRecommenderV1beta1RecommendationStateInfo; + } + /** + * Contains what resources are changing and how they are changing. + */ + export interface Schema$GoogleCloudRecommenderV1beta1RecommendationContent { + /** + * Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order. + */ + operationGroups?: Schema$GoogleCloudRecommenderV1beta1OperationGroup[]; + } + /** + * Information for state. Contains state and metadata. + */ + export interface Schema$GoogleCloudRecommenderV1beta1RecommendationStateInfo { + /** + * The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. + */ + state?: string | null; + /** + * A map of metadata for the state, provided by user or automations systems. + */ + stateMetadata?: {[key: string]: string} | null; + } + /** + * Contains various matching options for values for a GCP resource field. + */ + export interface Schema$GoogleCloudRecommenderV1beta1ValueMatcher { + /** + * To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch + */ + matchesPattern?: string | null; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$GoogleTypeMoney { + /** + * The 3-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: 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); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + recommenders: Resource$Projects$Locations$Recommenders; + constructor(context: APIRequestContext) { + this.context = context; + this.recommenders = new Resource$Projects$Locations$Recommenders( + this.context + ); + } + } + + export class Resource$Projects$Locations$Recommenders { + context: APIRequestContext; + recommendations: Resource$Projects$Locations$Recommenders$Recommendations; + constructor(context: APIRequestContext) { + this.context = context; + this.recommendations = new Resource$Projects$Locations$Recommenders$Recommendations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Recommenders$Recommendations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * recommender.projects.locations.recommenders.recommendations.get + * @desc Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. + * @alias recommender.projects.locations.recommenders.recommendations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the recommendation. + * @param {object} [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$Recommenders$Recommendations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Get, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + get( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Get, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + get( + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Recommenders$Recommendations$Get + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void | GaxiosPromise< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Recommenders$Recommendations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://recommender.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< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >(parameters); + } + } + + /** + * recommender.projects.locations.recommenders.recommendations.list + * @desc Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender. + * @alias recommender.projects.locations.recommenders.recommendations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" + * @param {integer=} params.pageSize Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + * @param {string=} params.pageToken Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. + * @param {string} params.parent Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + * @param {object} [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$Recommenders$Recommendations$List, + options?: MethodOptions + ): GaxiosPromise< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + >; + list( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$List, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + > + ): void; + list( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$List, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Recommenders$Recommendations$List + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Recommenders$Recommendations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/recommendations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudRecommenderV1beta1ListRecommendationsResponse + >(parameters); + } + } + + /** + * recommender.projects.locations.recommenders.recommendations.markClaimed + * @desc Mark the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. + * @alias recommender.projects.locations.recommenders.recommendations.markClaimed + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the recommendation. + * @param {().GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + markClaimed( + params?: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed, + options?: MethodOptions + ): GaxiosPromise; + markClaimed( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markClaimed( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markClaimed( + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markClaimed( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void | GaxiosPromise< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:markClaimed').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >(parameters); + } + } + + /** + * recommender.projects.locations.recommenders.recommendations.markFailed + * @desc Mark the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. + * @alias recommender.projects.locations.recommenders.recommendations.markFailed + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the recommendation. + * @param {().GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + markFailed( + params?: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed, + options?: MethodOptions + ): GaxiosPromise; + markFailed( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markFailed( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markFailed( + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markFailed( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void | GaxiosPromise< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:markFailed').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >(parameters); + } + } + + /** + * recommender.projects.locations.recommenders.recommendations.markSucceeded + * @desc Mark the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. + * @alias recommender.projects.locations.recommenders.recommendations.markSucceeded + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the recommendation. + * @param {().GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + markSucceeded( + params?: Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded, + options?: MethodOptions + ): GaxiosPromise; + markSucceeded( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markSucceeded( + params: Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded, + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markSucceeded( + callback: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void; + markSucceeded( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > + ): void | GaxiosPromise< + Schema$GoogleCloudRecommenderV1beta1Recommendation + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://recommender.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:markSucceeded').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$GoogleCloudRecommenderV1beta1Recommendation + >(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the recommendation. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" + */ + filter?: string; + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. + */ + pageSize?: number; + /** + * Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The container resource on which to execute the request. Acceptable formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$Markclaimed + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the recommendation. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest; + } + export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$Markfailed + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the recommendation. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest; + } + export interface Params$Resource$Projects$Locations$Recommenders$Recommendations$Marksucceeded + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the recommendation. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest; + } +} diff --git a/src/apis/recommender/webpack.config.js b/src/apis/recommender/webpack.config.js new file mode 100644 index 00000000000..ab6881aa8df --- /dev/null +++ b/src/apis/recommender/webpack.config.js @@ -0,0 +1,71 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Recommender', + filename: 'recommender.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/redis/v1.ts b/src/apis/redis/v1.ts index 5667437336c..a02dcb66cbf 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -228,7 +228,7 @@ export namespace redis_v1 { */ export interface Schema$Instance { /** - * Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id]. + * Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in location_id. */ alternativeLocationId?: string | null; /** @@ -240,7 +240,7 @@ export namespace redis_v1 { */ createTime?: string | null; /** - * Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id] or [alternative_location_id] and can change after a failover event. + * Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event. */ currentLocationId?: string | null; /** @@ -256,7 +256,7 @@ export namespace redis_v1 { */ labels?: {[key: string]: string} | null; /** - * Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id] is also provided, it must be different from [location_id]. + * Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If alternative_location_id is also provided, it must be different from location_id. */ locationId?: string | null; /** @@ -264,7 +264,7 @@ export namespace redis_v1 { */ memorySizeGb?: number | null; /** - * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. */ name?: string | null; /** @@ -305,7 +305,7 @@ export namespace redis_v1 { */ export interface Schema$ListInstancesResponse { /** - * A list of Redis instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the "name" field set to a value of the form projects/{project_id}/locations/{location_id}/instances/- and the "status" field set to ERROR and "status_message" field set to "location not available for ListInstances". + * A list of Redis instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/instances/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListInstances". */ instances?: Schema$Instance[]; /** @@ -1070,13 +1070,13 @@ export namespace redis_v1 { /** * redis.projects.locations.instances.list - * @desc Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. + * @desc Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. * @alias redis.projects.locations.instances.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. - * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {integer=} params.pageSize The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried. + * @param {string=} params.pageToken The `next_page_token` value returned from a previous ListInstances request, if any. * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1153,7 +1153,7 @@ export namespace redis_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. + * @param {string} params.name Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. * @param {string=} params.updateMask Required. 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 from Instance: * `displayName` * `labels` * `memorySizeGb` * `redisConfig` * @param {().Instance} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1324,11 +1324,11 @@ export namespace redis_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. + * The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried. */ pageSize?: number; /** - * The next_page_token value returned from a previous List request, if any. + * The `next_page_token` value returned from a previous ListInstances request, if any. */ pageToken?: string; /** @@ -1344,7 +1344,7 @@ export namespace redis_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. */ name?: string; /** diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 7ec9e62cf28..768c75c0acc 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -228,7 +228,7 @@ export namespace redis_v1beta1 { */ export interface Schema$Instance { /** - * Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id]. + * Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in location_id. */ alternativeLocationId?: string | null; /** @@ -240,7 +240,7 @@ export namespace redis_v1beta1 { */ createTime?: string | null; /** - * Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id] or [alternative_location_id] and can change after a failover event. + * Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event. */ currentLocationId?: string | null; /** @@ -256,7 +256,7 @@ export namespace redis_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id] is also provided, it must be different from [location_id]. + * Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If alternative_location_id is also provided, it must be different from location_id. */ locationId?: string | null; /** @@ -264,7 +264,7 @@ export namespace redis_v1beta1 { */ memorySizeGb?: number | null; /** - * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. */ name?: string | null; /** @@ -305,7 +305,7 @@ export namespace redis_v1beta1 { */ export interface Schema$ListInstancesResponse { /** - * A list of Redis instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the "name" field set to a value of the form projects/{project_id}/locations/{location_id}/instances/- and the "status" field set to ERROR and "status_message" field set to "location not available for ListInstances". + * A list of Redis instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/instances/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListInstances". */ instances?: Schema$Instance[]; /** @@ -1076,13 +1076,13 @@ export namespace redis_v1beta1 { /** * redis.projects.locations.instances.list - * @desc Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. + * @desc Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. * @alias redis.projects.locations.instances.list * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. - * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {integer=} params.pageSize The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried. + * @param {string=} params.pageToken The `next_page_token` value returned from a previous ListInstances request, if any. * @param {string} params.parent Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1159,7 +1159,7 @@ export namespace redis_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. + * @param {string} params.name Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. * @param {string=} params.updateMask Required. 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 from Instance: * `displayName` * `labels` * `memorySizeGb` * `redisConfig` * @param {().Instance} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1330,11 +1330,11 @@ export namespace redis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. + * The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried. */ pageSize?: number; /** - * The next_page_token value returned from a previous List request, if any. + * The `next_page_token` value returned from a previous ListInstances request, if any. */ pageToken?: string; /** @@ -1350,7 +1350,7 @@ export namespace redis_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. */ name?: string; /** diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index ab3d76f8f44..324de9235a8 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -108,7 +108,6 @@ export namespace remotebuildexecution_v1 { media: Resource$Media; operations: Resource$Operations; projects: Resource$Projects; - v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -119,7 +118,6 @@ export namespace remotebuildexecution_v1 { this.media = new Resource$Media(this.context); this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); - this.v1 = new Resource$V1(this.context); } } @@ -543,10 +541,22 @@ export namespace remotebuildexecution_v1 { * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ dockerPrep?: string | null; + /** + * The timestamp when docker prepartion begins. + */ + dockerPrepStartTime?: string | null; /** * The time spent downloading the input files and constructing the working directory. */ download?: string | null; + /** + * The timestamp when downloading the input files begins. + */ + downloadStartTime?: string | null; + /** + * The timestamp when execution begins. + */ + execStartTime?: string | null; /** * The time spent executing the command (i.e., doing useful work). */ @@ -567,6 +577,10 @@ export namespace remotebuildexecution_v1 { * The time spent uploading the output files. */ upload?: string | null; + /** + * The timestamp when uploading the output files begins. + */ + uploadStartTime?: string | null; } /** * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. @@ -607,11 +621,11 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig { /** - * The number of the guest accelerator cards exposed to this VM. + * The number of guest accelerator cards exposed to each VM. */ acceleratorCount?: string | null; /** - * The type of accelerator to attach to this VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. + * The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. */ acceleratorType?: string | null; } @@ -775,6 +789,10 @@ export namespace remotebuildexecution_v1 { * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ minCpuPlatform?: string | null; + /** + * Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through `restricted.googleapis.com` (`199.36.153.4/30`). + */ + networkAccess?: string | null; /** * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ @@ -801,260 +819,6 @@ export namespace remotebuildexecution_v1 { */ workerCount?: string | null; } - /** - * An ActionResult represents the result of an Action being run. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testActionResult { - /** - * The exit code of the command. - */ - exitCode?: number | null; - /** - * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` - */ - outputDirectories?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory[]; - /** - * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present in the output list. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. - */ - outputFiles?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile[]; - /** - * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. - */ - stderrDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. - */ - stderrRaw?: string | null; - /** - * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. - */ - stdoutDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. - */ - stdoutRaw?: string | null; - } - /** - * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommand { - /** - * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. - */ - arguments?: string[] | null; - /** - * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. - */ - environmentVariables?: Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable[]; - } - /** - * An `EnvironmentVariable` is one variable to set in the running program's environment. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable { - /** - * The variable name. - */ - name?: string | null; - /** - * The variable value. - */ - value?: string | null; - } - /** - * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDigest { - /** - * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. - */ - hash?: string | null; - /** - * The size of the blob, in bytes. - */ - sizeBytes?: string | null; - } - /** - * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectory { - /** - * The subdirectories in the directory. - */ - directories?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode[]; - /** - * The files in the directory. - */ - files?: Schema$GoogleDevtoolsRemoteexecutionV1testFileNode[]; - } - /** - * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode { - /** - * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The name of the directory. - */ - name?: string | null; - } - /** - * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata { - /** - * The digest of the Action being executed. - */ - actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - stage?: string | null; - /** - * If set, the client can use this name with ByteStream.Read to stream the standard error. - */ - stderrStreamName?: string | null; - /** - * If set, the client can use this name with ByteStream.Read to stream the standard output. - */ - stdoutStreamName?: string | null; - } - /** - * The response message for Execution.Execute, which will be contained in the response field of the Operation. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteResponse { - /** - * True if the result was served from cache, false if it was executed. - */ - cachedResult?: boolean | null; - /** - * The result of the action. - */ - result?: Schema$GoogleDevtoolsRemoteexecutionV1testActionResult; - /** - * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. - */ - serverLogs?: { - [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; - } | null; - /** - * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. - */ - status?: Schema$GoogleRpcStatus; - } - /** - * A `FileNode` represents a single file and associated metadata. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testFileNode { - /** - * The digest of the file's content. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * True if file is executable, false otherwise. - */ - isExecutable?: boolean | null; - /** - * The name of the file. - */ - name?: string | null; - } - /** - * A `LogFile` is a log stored in the CAS. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testLogFile { - /** - * The digest of the log contents. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. - */ - humanReadable?: boolean | null; - } - /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory { - /** - * DEPRECATED: This field is deprecated and should no longer be used. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. - */ - path?: string | null; - /** - * The digest of the encoded Tree proto containing the directory's contents. - */ - treeDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - } - /** - * An `OutputFile` is similar to a FileNode, but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline. `OutputFile` is binary-compatible with `FileNode`. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile { - /** - * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. - */ - content?: string | null; - /** - * The digest of the file's content. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * True if file is executable, false otherwise. - */ - isExecutable?: boolean | null; - /** - * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. - */ - path?: string | null; - } - /** - * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testRequestMetadata { - /** - * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. - */ - actionId?: string | null; - /** - * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. - */ - correlatedInvocationsId?: string | null; - /** - * The details for the tool invoking the requests. - */ - toolDetails?: Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails; - /** - * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. - */ - toolInvocationId?: string | null; - } - /** - * Details for the tool used to call the API. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails { - /** - * Name of the tool, e.g. bazel. - */ - toolName?: string | null; - /** - * Version of the tool used for the request, e.g. 5.0.3. - */ - toolVersion?: string | null; - } - /** - * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testTree { - /** - * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. - */ - children?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory[]; - /** - * The root directory in the tree. - */ - root?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory; - } /** * AdminTemp is a prelimiary set of administration tasks. It's called "Temp" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API. This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be `"admin"` in these cases. This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming). */ @@ -1352,40 +1116,6 @@ export namespace remotebuildexecution_v1 { */ message?: string | null; } - /** - * A Change indicates the most recent state of an element. - */ - export interface Schema$GoogleWatcherV1Change { - /** - * If true, this Change is followed by more Changes that are in the same group as this Change. - */ - continued?: boolean | null; - /** - * The actual change data. This field is present only when `state() == EXISTS` or `state() == ERROR`. Please see google.protobuf.Any about how to use the Any type. - */ - data?: {[key: string]: any} | null; - /** - * Name of the element, interpreted relative to the entity's actual name. "" refers to the entity itself. The element name is a valid UTF-8 string. - */ - element?: string | null; - /** - * If present, provides a compact representation of all the messages that have been received by the caller for the given entity, e.g., it could be a sequence number or a multi-part timestamp/version vector. This marker can be provided in the Request message, allowing the caller to resume the stream watching at a specific point without fetching the initial state. - */ - resumeMarker?: string | null; - /** - * The state of the `element`. - */ - state?: string | null; - } - /** - * A batch of Change messages. - */ - export interface Schema$GoogleWatcherV1ChangeBatch { - /** - * A list of Change messages. - */ - changes?: Schema$GoogleWatcherV1Change[]; - } export class Resource$Media { context: APIRequestContext; @@ -2002,106 +1732,4 @@ export namespace remotebuildexecution_v1 { */ name?: string; } - - export class Resource$V1 { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * remotebuildexecution.watch - * @desc Start a streaming RPC to get watch information from the server. - * @alias remotebuildexecution.watch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.resumeMarker The `resume_marker` specifies how much of the existing underlying state is delivered to the client when the watch request is received by the system. The client can set this marker in one of the following ways to get different semantics: * Parameter is not specified or has the value "". Semantics: Fetch initial state. The client wants the entity's initial state to be delivered. See the description in "Initial State". * Parameter is set to the string "now" (UTF-8 encoding). Semantics: Fetch new changes only. The client just wants to get the changes received by the system after the watch point. The system may deliver changes from before the watch point as well. * Parameter is set to a value received in an earlier `Change.resume_marker` field while watching the same entity. Semantics: Resume from a specific point. The client wants to receive the changes from a specific point; this value must correspond to a value received in the `Change.resume_marker` field. The system may deliver changes from before the `resume_marker` as well. If the system cannot resume the stream from this point (e.g., if it is too far behind in the stream), it can raise the `FAILED_PRECONDITION` error. An implementation MUST support an unspecified parameter and the empty string "" marker (initial state fetching) and the "now" marker. It need not support resuming from a specific point. - * @param {string=} params.target The `target` value **must** be a valid URL path pointing to an entity to watch. Note that the service name **must** be removed from the target field (e.g., the target field must say "/foo/bar", not "myservice.googleapis.com/foo/bar"). A client is also allowed to pass system-specific parameters in the URL that are only obeyed by some implementations. Some parameters will be implementation-specific. However, some have predefined meaning and are listed here: * recursive = true|false [default=false] If set to true, indicates that the client wants to watch all elements of entities in the subtree rooted at the entity's name in `target`. For descendants that are not the immediate children of the target, the `Change.element` will contain slashes. Note that some namespaces and entities will not support recursive watching. When watching such an entity, a client must not set recursive to true. Otherwise, it will receive an `UNIMPLEMENTED` error. Normal URL encoding must be used inside `target`. For example, if a query parameter name or value, or the non-query parameter portion of `target` contains a special character, it must be %-encoded. We recommend that clients and servers use their runtime's URL library to produce and consume target values. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - watch( - params?: Params$Resource$V1$Watch, - options?: MethodOptions - ): GaxiosPromise; - watch( - params: Params$Resource$V1$Watch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - watch( - params: Params$Resource$V1$Watch, - callback: BodyResponseCallback - ): void; - watch( - callback: BodyResponseCallback - ): void; - watch( - paramsOrCallback?: - | Params$Resource$V1$Watch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$V1$Watch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1$Watch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://remotebuildexecution.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1:watch').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$V1$Watch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The `resume_marker` specifies how much of the existing underlying state is delivered to the client when the watch request is received by the system. The client can set this marker in one of the following ways to get different semantics: * Parameter is not specified or has the value "". Semantics: Fetch initial state. The client wants the entity's initial state to be delivered. See the description in "Initial State". * Parameter is set to the string "now" (UTF-8 encoding). Semantics: Fetch new changes only. The client just wants to get the changes received by the system after the watch point. The system may deliver changes from before the watch point as well. * Parameter is set to a value received in an earlier `Change.resume_marker` field while watching the same entity. Semantics: Resume from a specific point. The client wants to receive the changes from a specific point; this value must correspond to a value received in the `Change.resume_marker` field. The system may deliver changes from before the `resume_marker` as well. If the system cannot resume the stream from this point (e.g., if it is too far behind in the stream), it can raise the `FAILED_PRECONDITION` error. An implementation MUST support an unspecified parameter and the empty string "" marker (initial state fetching) and the "now" marker. It need not support resuming from a specific point. - */ - resumeMarker?: string; - /** - * The `target` value **must** be a valid URL path pointing to an entity to watch. Note that the service name **must** be removed from the target field (e.g., the target field must say "/foo/bar", not "myservice.googleapis.com/foo/bar"). A client is also allowed to pass system-specific parameters in the URL that are only obeyed by some implementations. Some parameters will be implementation-specific. However, some have predefined meaning and are listed here: * recursive = true|false [default=false] If set to true, indicates that the client wants to watch all elements of entities in the subtree rooted at the entity's name in `target`. For descendants that are not the immediate children of the target, the `Change.element` will contain slashes. Note that some namespaces and entities will not support recursive watching. When watching such an entity, a client must not set recursive to true. Otherwise, it will receive an `UNIMPLEMENTED` error. Normal URL encoding must be used inside `target`. For example, if a query parameter name or value, or the non-query parameter portion of `target` contains a special character, it must be %-encoded. We recommend that clients and servers use their runtime's URL library to produce and consume target values. - */ - target?: string; - } } diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index b6097a04634..699a298bf9d 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -528,10 +528,22 @@ export namespace remotebuildexecution_v1alpha { * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ dockerPrep?: string | null; + /** + * The timestamp when docker prepartion begins. + */ + dockerPrepStartTime?: string | null; /** * The time spent downloading the input files and constructing the working directory. */ download?: string | null; + /** + * The timestamp when downloading the input files begins. + */ + downloadStartTime?: string | null; + /** + * The timestamp when execution begins. + */ + execStartTime?: string | null; /** * The time spent executing the command (i.e., doing useful work). */ @@ -552,6 +564,10 @@ export namespace remotebuildexecution_v1alpha { * The time spent uploading the output files. */ upload?: string | null; + /** + * The timestamp when uploading the output files begins. + */ + uploadStartTime?: string | null; } /** * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. @@ -592,11 +608,11 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig { /** - * The number of the guest accelerator cards exposed to this VM. + * The number of guest accelerator cards exposed to each VM. */ acceleratorCount?: string | null; /** - * The type of accelerator to attach to this VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. + * The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. */ acceleratorType?: string | null; } @@ -760,6 +776,10 @@ export namespace remotebuildexecution_v1alpha { * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ minCpuPlatform?: string | null; + /** + * Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through `restricted.googleapis.com` (`199.36.153.4/30`). + */ + networkAccess?: string | null; /** * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ @@ -786,260 +806,6 @@ export namespace remotebuildexecution_v1alpha { */ workerCount?: string | null; } - /** - * An ActionResult represents the result of an Action being run. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testActionResult { - /** - * The exit code of the command. - */ - exitCode?: number | null; - /** - * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` - */ - outputDirectories?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory[]; - /** - * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present in the output list. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. - */ - outputFiles?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile[]; - /** - * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. - */ - stderrDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. - */ - stderrRaw?: string | null; - /** - * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. - */ - stdoutDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. - */ - stdoutRaw?: string | null; - } - /** - * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommand { - /** - * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. - */ - arguments?: string[] | null; - /** - * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. - */ - environmentVariables?: Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable[]; - } - /** - * An `EnvironmentVariable` is one variable to set in the running program's environment. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable { - /** - * The variable name. - */ - name?: string | null; - /** - * The variable value. - */ - value?: string | null; - } - /** - * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDigest { - /** - * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. - */ - hash?: string | null; - /** - * The size of the blob, in bytes. - */ - sizeBytes?: string | null; - } - /** - * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectory { - /** - * The subdirectories in the directory. - */ - directories?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode[]; - /** - * The files in the directory. - */ - files?: Schema$GoogleDevtoolsRemoteexecutionV1testFileNode[]; - } - /** - * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode { - /** - * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The name of the directory. - */ - name?: string | null; - } - /** - * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata { - /** - * The digest of the Action being executed. - */ - actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - stage?: string | null; - /** - * If set, the client can use this name with ByteStream.Read to stream the standard error. - */ - stderrStreamName?: string | null; - /** - * If set, the client can use this name with ByteStream.Read to stream the standard output. - */ - stdoutStreamName?: string | null; - } - /** - * The response message for Execution.Execute, which will be contained in the response field of the Operation. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteResponse { - /** - * True if the result was served from cache, false if it was executed. - */ - cachedResult?: boolean | null; - /** - * The result of the action. - */ - result?: Schema$GoogleDevtoolsRemoteexecutionV1testActionResult; - /** - * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. - */ - serverLogs?: { - [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; - } | null; - /** - * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. - */ - status?: Schema$GoogleRpcStatus; - } - /** - * A `FileNode` represents a single file and associated metadata. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testFileNode { - /** - * The digest of the file's content. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * True if file is executable, false otherwise. - */ - isExecutable?: boolean | null; - /** - * The name of the file. - */ - name?: string | null; - } - /** - * A `LogFile` is a log stored in the CAS. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testLogFile { - /** - * The digest of the log contents. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. - */ - humanReadable?: boolean | null; - } - /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory { - /** - * DEPRECATED: This field is deprecated and should no longer be used. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. - */ - path?: string | null; - /** - * The digest of the encoded Tree proto containing the directory's contents. - */ - treeDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - } - /** - * An `OutputFile` is similar to a FileNode, but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline. `OutputFile` is binary-compatible with `FileNode`. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile { - /** - * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. - */ - content?: string | null; - /** - * The digest of the file's content. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * True if file is executable, false otherwise. - */ - isExecutable?: boolean | null; - /** - * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. - */ - path?: string | null; - } - /** - * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testRequestMetadata { - /** - * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. - */ - actionId?: string | null; - /** - * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. - */ - correlatedInvocationsId?: string | null; - /** - * The details for the tool invoking the requests. - */ - toolDetails?: Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails; - /** - * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. - */ - toolInvocationId?: string | null; - } - /** - * Details for the tool used to call the API. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails { - /** - * Name of the tool, e.g. bazel. - */ - toolName?: string | null; - /** - * Version of the tool used for the request, e.g. 5.0.3. - */ - toolVersion?: string | null; - } - /** - * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testTree { - /** - * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. - */ - children?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory[]; - /** - * The root directory in the tree. - */ - root?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory; - } /** * AdminTemp is a prelimiary set of administration tasks. It's called "Temp" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API. This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be `"admin"` in these cases. This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming). */ diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index eb855718a12..807e5ad86f3 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -796,10 +796,22 @@ export namespace remotebuildexecution_v2 { * The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary). */ dockerPrep?: string | null; + /** + * The timestamp when docker prepartion begins. + */ + dockerPrepStartTime?: string | null; /** * The time spent downloading the input files and constructing the working directory. */ download?: string | null; + /** + * The timestamp when downloading the input files begins. + */ + downloadStartTime?: string | null; + /** + * The timestamp when execution begins. + */ + execStartTime?: string | null; /** * The time spent executing the command (i.e., doing useful work). */ @@ -820,6 +832,10 @@ export namespace remotebuildexecution_v2 { * The time spent uploading the output files. */ upload?: string | null; + /** + * The timestamp when uploading the output files begins. + */ + uploadStartTime?: string | null; } /** * CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command. @@ -860,11 +876,11 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig { /** - * The number of the guest accelerator cards exposed to this VM. + * The number of guest accelerator cards exposed to each VM. */ acceleratorCount?: string | null; /** - * The type of accelerator to attach to this VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. + * The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80. */ acceleratorType?: string | null; } @@ -1028,6 +1044,10 @@ export namespace remotebuildexecution_v2 { * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ minCpuPlatform?: string | null; + /** + * Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through `restricted.googleapis.com` (`199.36.153.4/30`). + */ + networkAccess?: string | null; /** * Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details. */ @@ -1054,260 +1074,6 @@ export namespace remotebuildexecution_v2 { */ workerCount?: string | null; } - /** - * An ActionResult represents the result of an Action being run. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testActionResult { - /** - * The exit code of the command. - */ - exitCode?: number | null; - /** - * The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` - */ - outputDirectories?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory[]; - /** - * The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present in the output list. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted. - */ - outputFiles?: Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile[]; - /** - * The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage. See `stderr_raw` for when this will be set. - */ - stderrDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stderr_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. - */ - stderrRaw?: string | null; - /** - * The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage. See `stdout_raw` for when this will be set. - */ - stdoutDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in `stdout_digest` that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. - */ - stdoutRaw?: string | null; - } - /** - * A `Command` is the actual command executed by a worker running an Action. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommand { - /** - * The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path. The working directory will always be the input root. - */ - arguments?: string[] | null; - /** - * The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent `Command`s always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. - */ - environmentVariables?: Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable[]; - } - /** - * An `EnvironmentVariable` is one variable to set in the running program's environment. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable { - /** - * The variable name. - */ - name?: string | null; - /** - * The variable value. - */ - value?: string | null; - } - /** - * A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDigest { - /** - * The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long. - */ - hash?: string | null; - /** - * The size of the blob, in bytes. - */ - sizeBytes?: string | null; - } - /** - * A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: - Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file name). - The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ``` - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectory { - /** - * The subdirectories in the directory. - */ - directories?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode[]; - /** - * The files in the directory. - */ - files?: Schema$GoogleDevtoolsRemoteexecutionV1testFileNode[]; - } - /** - * A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testDirectoryNode { - /** - * The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The name of the directory. - */ - name?: string | null; - } - /** - * Metadata about an ongoing execution, which will be contained in the metadata field of the Operation. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata { - /** - * The digest of the Action being executed. - */ - actionDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - stage?: string | null; - /** - * If set, the client can use this name with ByteStream.Read to stream the standard error. - */ - stderrStreamName?: string | null; - /** - * If set, the client can use this name with ByteStream.Read to stream the standard output. - */ - stdoutStreamName?: string | null; - } - /** - * The response message for Execution.Execute, which will be contained in the response field of the Operation. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testExecuteResponse { - /** - * True if the result was served from cache, false if it was executed. - */ - cachedResult?: boolean | null; - /** - * The result of the action. - */ - result?: Schema$GoogleDevtoolsRemoteexecutionV1testActionResult; - /** - * An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. - */ - serverLogs?: { - [key: string]: Schema$GoogleDevtoolsRemoteexecutionV1testLogFile; - } | null; - /** - * If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action. - */ - status?: Schema$GoogleRpcStatus; - } - /** - * A `FileNode` represents a single file and associated metadata. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testFileNode { - /** - * The digest of the file's content. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * True if file is executable, false otherwise. - */ - isExecutable?: boolean | null; - /** - * The name of the file. - */ - name?: string | null; - } - /** - * A `LogFile` is a log stored in the CAS. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testLogFile { - /** - * The digest of the log contents. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file. - */ - humanReadable?: boolean | null; - } - /** - * An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputDirectory { - /** - * DEPRECATED: This field is deprecated and should no longer be used. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory. - */ - path?: string | null; - /** - * The digest of the encoded Tree proto containing the directory's contents. - */ - treeDigest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - } - /** - * An `OutputFile` is similar to a FileNode, but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline. `OutputFile` is binary-compatible with `FileNode`. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testOutputFile { - /** - * The raw content of the file. This field may be used by the server to provide the content of a file inline in an ActionResult and avoid requiring that the client make a separate call to [ContentAddressableStorage.GetBlob] to retrieve it. The client SHOULD NOT assume that it will get raw content with any request, and always be prepared to retrieve it via `digest`. - */ - content?: string | null; - /** - * The digest of the file's content. - */ - digest?: Schema$GoogleDevtoolsRemoteexecutionV1testDigest; - /** - * True if file is executable, false otherwise. - */ - isExecutable?: boolean | null; - /** - * The full path of the file relative to the input root, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. - */ - path?: string | null; - } - /** - * An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testRequestMetadata { - /** - * An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc. - */ - actionId?: string | null; - /** - * An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. - */ - correlatedInvocationsId?: string | null; - /** - * The details for the tool invoking the requests. - */ - toolDetails?: Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails; - /** - * An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. - */ - toolInvocationId?: string | null; - } - /** - * Details for the tool used to call the API. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testToolDetails { - /** - * Name of the tool, e.g. bazel. - */ - toolName?: string | null; - /** - * Version of the tool used for the request, e.g. 5.0.3. - */ - toolVersion?: string | null; - } - /** - * A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message. - */ - export interface Schema$GoogleDevtoolsRemoteexecutionV1testTree { - /** - * All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`. - */ - children?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory[]; - /** - * The root directory in the tree. - */ - root?: Schema$GoogleDevtoolsRemoteexecutionV1testDirectory; - } /** * AdminTemp is a prelimiary set of administration tasks. It's called "Temp" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API. This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be `"admin"` in these cases. This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming). */ diff --git a/src/apis/reseller/v1.ts b/src/apis/reseller/v1.ts index c07e56fdc09..e1c2be8ca77 100644 --- a/src/apis/reseller/v1.ts +++ b/src/apis/reseller/v1.ts @@ -1319,7 +1319,7 @@ export namespace reseller_v1 { /** * reseller.subscriptions.delete - * @desc Cancel or transfer a subscription to direct. + * @desc Cancel, suspend, or transfer a subscription to direct. * @alias reseller.subscriptions.delete * @memberOf! () * diff --git a/src/apis/run/index.ts b/src/apis/run/index.ts index 3fab8e0727a..c2213a5405a 100644 --- a/src/apis/run/index.ts +++ b/src/apis/run/index.ts @@ -16,19 +16,29 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {run_v1} from './v1'; import {run_v1alpha1} from './v1alpha1'; +import {run_v1beta1} from './v1beta1'; export const VERSIONS = { v1: run_v1.Run, v1alpha1: run_v1alpha1.Run, + v1beta1: run_v1beta1.Run, }; export function run(version: 'v1'): run_v1.Run; export function run(options: run_v1.Options): run_v1.Run; export function run(version: 'v1alpha1'): run_v1alpha1.Run; export function run(options: run_v1alpha1.Options): run_v1alpha1.Run; -export function run( +export function run(version: 'v1beta1'): run_v1beta1.Run; +export function run(options: run_v1beta1.Options): run_v1beta1.Run; +export function run( this: GoogleConfigurable, - versionOrOptions: 'v1' | run_v1.Options | 'v1alpha1' | run_v1alpha1.Options + versionOrOptions: + | 'v1' + | run_v1.Options + | 'v1alpha1' + | run_v1alpha1.Options + | 'v1beta1' + | run_v1beta1.Options ) { return getAPI('run', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 4f2cd464050..cb4a6709a01 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -105,6 +105,7 @@ export namespace run_v1 { */ export class Run { context: APIRequestContext; + namespaces: Resource$Namespaces; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -113,104 +114,7450 @@ export namespace run_v1 { google, }; + this.namespaces = new Resource$Namespaces(this.context); this.projects = new Resource$Projects(this.context); } } /** - * The response message for Locations.ListLocations. + * Information for connecting over HTTP(s). */ - export interface Schema$ListLocationsResponse { + export interface Schema$Addressable { + url?: 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 { /** - * A list of locations that matches the specified filter in the request. + * The configuration for logging of each type of permission. */ - locations?: Schema$Location[]; + auditLogConfigs?: Schema$AuditLogConfig[]; /** - * The standard List next-page token. + * 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. */ - nextPageToken?: string | null; + service?: string | null; } /** - * A resource that represents Google Cloud Platform location. + * 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$Location { + export interface Schema$AuditLogConfig { /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - displayName?: string | null; + exemptedMembers?: string[] | null; /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} + * The log type that this config enables. */ - labels?: {[key: string]: string} | null; + logType?: string | null; + } + /** + * A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via [Webmaster Central](https://www.google.com/webmasters/verification/home). + */ + export interface Schema$AuthorizedDomain { /** - * The canonical id for this location. For example: `"us-east1"`. + * Relative name of the domain authorized for use. Example: `example.com`. */ - locationId?: string | null; + id?: string | null; /** - * Service-specific metadata. For example the available capacity at the given location. + * Read only. Full path to the `AuthorizedDomain` resource in the API. Example: `apps/myapp/authorizedDomains/example.com`. */ - metadata?: {[key: string]: any} | null; + name?: string | null; + } + /** + * Resource to hold the state and status of a user's auto domain mapping. + */ + export interface Schema$AutoDomainMapping { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case "AutoDomainMapping". + */ + kind?: string | null; + /** + * Metadata associated with this BuildTemplate. + */ + metadata?: Schema$ObjectMeta; + /** + * The spec for this AutoDomainMapping. + */ + spec?: Schema$AutoDomainMappingSpec; + /** + * The current status of the AutoDomainMapping. + */ + status?: Schema$AutoDomainMappingStatus; + } + /** + * The desired state of the Auto Domain Mapping. + */ + export interface Schema$AutoDomainMappingSpec { + /** + * The mode of the certificate. + */ + certificateMode?: string | null; + /** + * The type of expansion for the auto auto domain mapping. + */ + expansionType?: string | null; + /** + * If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning. + */ + forceOverride?: boolean | null; + } + /** + * The current state of the Domain Mapping. + */ + export interface Schema$AutoDomainMappingStatus { + /** + * Array of observed AutoDomainMappingConditions, indicating the current state of the AutoDomainMapping. + */ + conditions?: Schema$GoogleCloudRunV1Condition[]; + /** + * ObservedGeneration is the 'Generation' of the AutoDomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. + */ + observedGeneration?: number | null; + /** + * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. + */ + resourceRecords?: Schema$ResourceRecord[]; + } + /** + * 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`. * `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; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + */ + export interface Schema$ConfigMapEnvSource { + /** + * This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. + */ + localObjectReference?: Schema$LocalObjectReference; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The ConfigMap to select from. + */ + name?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the ConfigMap must be defined + */ + optional?: boolean | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Selects a key from a ConfigMap. + */ + export interface Schema$ConfigMapKeySelector { + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The key to select. + */ + key?: string | null; + /** + * This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. + */ + localObjectReference?: Schema$LocalObjectReference; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The ConfigMap to select from. + */ + name?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the ConfigMap or its key must be defined + */ + optional?: boolean | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. + */ + export interface Schema$ConfigMapVolumeSource { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + */ + defaultMode?: number | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. + */ + items?: Schema$KeyToPath[]; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Name of the config. + */ + name?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the Secret or its keys must be defined. + */ + optional?: boolean | null; + } + /** + * Configuration represents the "floating HEAD" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The "latest created" revision's name is available under status, as is the "latest ready" revision's name. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration + */ + export interface Schema$Configuration { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case always "Configuration". + */ + kind?: string | null; + /** + * Metadata associated with this Configuration, including name, namespace, labels, and annotations. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec holds the desired state of the Configuration (from the client). + */ + spec?: Schema$ConfigurationSpec; + /** + * Status communicates the observed state of the Configuration (from the controller). + */ + status?: Schema$ConfigurationStatus; + } + /** + * ConfigurationSpec holds the desired state of the Configuration (from the client). + */ + export interface Schema$ConfigurationSpec { + /** + * Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. To set minimum instances for this revision, use the "autoscaling.knative.dev/minScale" annotation key. (Cloud Run for Anthos only). To set maximum instances for this revision, use the "autoscaling.knative.dev/maxScale" annotation key. To set Cloud SQL connections for the revision, use the "run.googleapis.com/cloudsql-instances" annotation key. Values should be comma separated. + */ + template?: Schema$RevisionTemplate; + } + /** + * ConfigurationStatus communicates the observed state of the Configuration (from the controller). + */ + export interface Schema$ConfigurationStatus { + /** + * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. + */ + conditions?: Schema$GoogleCloudRunV1Condition[]; + /** + * LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, for that use LatestReadyRevisionName. + */ + latestCreatedRevisionName?: string | null; + /** + * LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True". + */ + latestReadyRevisionName?: string | null; + /** + * ObservedGeneration is the 'Generation' of the Configuration that was last processed by the controller. The observed generation is updated even if the controller failed to process the spec and create the Revision. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False. + */ + observedGeneration?: number | null; + } + /** + * A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. + */ + export interface Schema$Container { + /** + * (Optional) Cloud Run fully managed: supported Cloud Run for Anthos: supported Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + */ + args?: string[] | null; + command?: string[] | null; + /** + * (Optional) Cloud Run fully managed: supported Cloud Run for Anthos: supported List of environment variables to set in the container. + */ + env?: Schema$EnvVar[]; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + */ + envFrom?: Schema$EnvFromSource[]; + /** + * Cloud Run fully managed: only supports containers from Google Container Registry Cloud Run for Anthos: supported URL of the Container image. More info: https://kubernetes.io/docs/concepts/containers/images + */ + image?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + */ + imagePullPolicy?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + */ + livenessProbe?: Schema$Probe; + /** + * (Optional) Name of the container specified as a DNS_LABEL. + */ + name?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. + */ + ports?: Schema$ContainerPort[]; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + */ + readinessProbe?: Schema$Probe; + /** + * (Optional) Cloud Run fully managed: supported Cloud Run for Anthos: supported Compute Resources required by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + */ + resources?: Schema$ResourceRequirements; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + */ + securityContext?: Schema$SecurityContext; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. + */ + terminationMessagePath?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + */ + terminationMessagePolicy?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Pod volumes to mount into the container's filesystem. + */ + volumeMounts?: Schema$VolumeMount[]; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. + */ + workingDir?: string | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported ContainerPort represents a network port in a single container. + */ + export interface Schema$ContainerPort { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + */ + containerPort?: number | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c". + */ + name?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Protocol for port. Must be TCP. Defaults to "TCP". + */ + protocol?: string | null; + } + /** + * Resource to hold the state and status of a user's domain mapping. + */ + export interface Schema$DomainMapping { + /** + * The API version for this call such as "domains.cloudrun.com/v1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case "DomainMapping". + */ + kind?: string | null; + /** + * Metadata associated with this BuildTemplate. + */ + metadata?: Schema$ObjectMeta; + /** + * The spec for this DomainMapping. + */ + spec?: Schema$DomainMappingSpec; + /** + * The current status of the DomainMapping. + */ + status?: Schema$DomainMappingStatus; + } + /** + * The desired state of the Domain Mapping. + */ + export interface Schema$DomainMappingSpec { + /** + * The mode of the certificate. + */ + certificateMode?: string | null; + /** + * If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning. + */ + forceOverride?: boolean | null; + /** + * The name of the Knative Route that this DomainMapping applies to. The route must exist. + */ + routeName?: string | null; + } + /** + * The current state of the Domain Mapping. + */ + export interface Schema$DomainMappingStatus { + /** + * Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. + */ + conditions?: Schema$GoogleCloudRunV1Condition[]; + /** + * The name of the route that the mapping currently points to. + */ + mappedRouteName?: string | null; + /** + * ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. + */ + observedGeneration?: number | null; + /** + * The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. + */ + resourceRecords?: Schema$ResourceRecord[]; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported EnvFromSource represents the source of a set of ConfigMaps + */ + export interface Schema$EnvFromSource { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The ConfigMap to select from + */ + configMapRef?: Schema$ConfigMapEnvSource; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + */ + prefix?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The Secret to select from + */ + secretRef?: Schema$SecretEnvSource; + } + /** + * EnvVar represents an environment variable present in a Container. + */ + export interface Schema$EnvVar { + /** + * Name of the environment variable. Must be a C_IDENTIFIER. + */ + name?: string | null; + /** + * (Optional) Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + */ + value?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Source for the environment variable's value. Cannot be used if value is not empty. + */ + valueFrom?: Schema$EnvVarSource; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported EnvVarSource represents a source for the value of an EnvVar. + */ + export interface Schema$EnvVarSource { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Selects a key of a ConfigMap. + */ + configMapKeyRef?: Schema$ConfigMapKeySelector; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Selects a key of a secret in the pod's namespace + */ + secretKeyRef?: Schema$SecretKeySelector; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported ExecAction describes a "run in container" action. + */ + export interface Schema$ExecAction { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + */ + 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" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | 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; + } + /** + * Condition defines a generic condition for a Resource + */ + export interface Schema$GoogleCloudRunV1Condition { + /** + * Optional. Last time the condition transitioned from one status to another. + */ + lastTransitionTime?: string | null; + /** + * Optional. Human readable message indicating details about the current status. + */ + message?: string | null; + /** + * Optional. One-word CamelCase reason for the condition's last transition. + */ + reason?: string | null; + /** + * Optional. How to interpret failures of this condition, one of Error, Warning, Info + */ + severity?: string | null; + /** + * Status of the condition, one of True, False, Unknown. + */ + status?: string | null; + /** + * type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + */ + type?: string | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Handler defines a specific action that should be taken + */ + export interface Schema$Handler { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported One and only one of the following should be specified. Exec specifies the action to take. + */ + exec?: Schema$ExecAction; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported HTTPGet specifies the http request to perform. + */ + httpGet?: Schema$HTTPGetAction; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported + */ + tcpSocket?: Schema$TCPSocketAction; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported HTTPGetAction describes an action based on HTTP Get requests. + */ + export interface Schema$HTTPGetAction { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + */ + host?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Custom headers to set in the request. HTTP allows repeated headers. + */ + httpHeaders?: Schema$HTTPHeader[]; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Path to access on the HTTP server. + */ + path?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Scheme to use for connecting to the host. Defaults to HTTP. + */ + scheme?: string | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported HTTPHeader describes a custom header to be used in HTTP probes + */ + export interface Schema$HTTPHeader { + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The header field name + */ + name?: string | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The header field value + */ + value?: string | null; + } + /** + * 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. + */ + export interface Schema$IntOrString { + /** + * The int value. + */ + intVal?: number | null; + /** + * The string value. + */ + strVal?: string | null; + /** + * The type of the value. + */ + type?: number | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Maps a string key to a path within a volume. + */ + export interface Schema$KeyToPath { + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The key to project. + */ + key?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + */ + mode?: number | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + */ + path?: string | null; + } + /** + * A list of Authorized Domains. + */ + export interface Schema$ListAuthorizedDomainsResponse { + /** + * The authorized domains belonging to the user. + */ + domains?: Schema$AuthorizedDomain[]; + /** + * Continuation token for fetching the next page of results. + */ + nextPageToken?: string | null; + } + /** + * ListAutoDomainMappingsResponse is a list of AutoDomainMapping resources. + */ + export interface Schema$ListAutoDomainMappingsResponse { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * List of AutoDomainMappings. + */ + items?: Schema$AutoDomainMapping[]; + /** + * The kind of this resource, in this case "AutoDomainMappingList". + */ + kind?: string | null; + /** + * Metadata associated with this AutoDomainMapping list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * ListConfigurationsResponse is a list of Configuration resources. + */ + export interface Schema$ListConfigurationsResponse { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * List of Configurations. + */ + items?: Schema$Configuration[]; + /** + * The kind of this resource, in this case "ConfigurationList". + */ + kind?: string | null; + /** + * Metadata associated with this Configuration list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * ListDomainMappingsResponse is a list of DomainMapping resources. + */ + export interface Schema$ListDomainMappingsResponse { + /** + * The API version for this call such as "domains.cloudrun.com/v1". + */ + apiVersion?: string | null; + /** + * List of DomainMappings. + */ + items?: Schema$DomainMapping[]; + /** + * The kind of this resource, in this case "DomainMappingList". + */ + kind?: string | null; + /** + * Metadata associated with this DomainMapping list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + 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. + */ + export interface Schema$ListRevisionsResponse { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * List of Revisions. + */ + items?: Schema$Revision[]; + /** + * The kind of this resource, in this case "RevisionList". + */ + kind?: string | null; + /** + * Metadata associated with this revision list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * ListRoutesResponse is a list of Route resources. + */ + export interface Schema$ListRoutesResponse { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * List of Routes. + */ + items?: Schema$Route[]; + /** + * The kind of this resource, in this case always "RouteList". + */ + kind?: string | null; + /** + * Metadata associated with this Route list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * A list of Service resources. + */ + export interface Schema$ListServicesResponse { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * List of Services. + */ + items?: Schema$Service[]; + /** + * The kind of this resource, in this case "ServiceList". + */ + kind?: string | null; + /** + * Metadata associated with this Service list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + */ + export interface Schema$LocalObjectReference { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + */ + name?: string | null; + } + /** + * 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; + } + /** + * k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + */ + export interface Schema$ObjectMeta { + /** + * (Optional) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations + */ + annotations?: {[key: string]: string} | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. + */ + clusterName?: string | null; + /** + * (Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + */ + creationTimestamp?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. + */ + deletionGracePeriodSeconds?: number | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + */ + deletionTimestamp?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +patchStrategy=merge + */ + finalizers?: string[] | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2; + */ + generateName?: string | null; + /** + * (Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. + */ + generation?: number | null; + /** + * (Optional) 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 + */ + labels?: {[key: string]: string} | null; + /** + * Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional + */ + name?: string | null; + /** + * Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. + */ + namespace?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. + */ + ownerReferences?: Schema$OwnerReference[]; + /** + * (Optional) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency + */ + resourceVersion?: string | null; + /** + * (Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4; + */ + selfLink?: string | null; + /** + * (Optional) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + */ + uid?: string | null; + } + /** + * OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field. + */ + export interface Schema$OwnerReference { + /** + * API version of the referent. + */ + apiVersion?: string | null; + /** + * If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional + */ + blockOwnerDeletion?: boolean | null; + /** + * If true, this reference points to the managing controller. +optional + */ + controller?: boolean | null; + /** + * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds + */ + kind?: string | null; + /** + * Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names + */ + name?: string | null; + /** + * UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + */ + uid?: 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). + */ + 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 when binding is in effect. `bindings` with no members will result in an error. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. 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?: 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 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. + */ + version?: number | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + */ + export interface Schema$Probe { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + */ + failureThreshold?: number | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The action taken to determine the health of a container + */ + handler?: Schema$Handler; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + */ + initialDelaySeconds?: number | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + */ + periodSeconds?: number | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. + */ + successThreshold?: number | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + */ + timeoutSeconds?: number | null; + } + /** + * A DNS resource record. + */ + export interface Schema$ResourceRecord { + /** + * Relative name of the object affected by this record. Only applicable for `CNAME` records. Example: 'www'. + */ + name?: string | null; + /** + * Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). + */ + rrdata?: string | null; + /** + * Resource record type. Example: `AAAA`. + */ + type?: string | null; + } + /** + * ResourceRequirements describes the compute resource requirements. + */ + export interface Schema$ResourceRequirements { + /** + * (Optional) Cloud Run fully managed: Only memory and CPU are supported. Note: The only supported value for CPU is '1'. Cloud Run for Anthos: supported Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go + */ + limits?: {[key: string]: string} | null; + /** + * (Optional) Cloud Run fully managed: Only memory and CPU are supported. Note: The only supported value for CPU is '1'. Cloud Run for Anthos: supported Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go + */ + requests?: {[key: string]: string} | null; + } + /** + * Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision + */ + export interface Schema$Revision { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * The kind of this resource, in this case "Revision". + */ + kind?: string | null; + /** + * Metadata associated with this Revision, including name, namespace, labels, and annotations. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec holds the desired state of the Revision (from the client). + */ + spec?: Schema$RevisionSpec; + /** + * Status communicates the observed state of the Revision (from the controller). + */ + status?: Schema$RevisionStatus; + } + /** + * RevisionSpec holds the desired state of the Revision (from the client). + */ + export interface Schema$RevisionSpec { + /** + * (Optional) ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. Cloud Run fully managed: supported, defaults to 80 Cloud Run for Anthos: supported, defaults to 0, which means concurrency to the application is not limited, and the system decides the target concurrency for the autoscaler. + */ + containerConcurrency?: number | null; + /** + * Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md + */ + containers?: Schema$Container[]; + /** + * Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. + */ + serviceAccountName?: string | null; + /** + * TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Not currently used by Cloud Run. + */ + timeoutSeconds?: number | null; + volumes?: Schema$Volume[]; + } + /** + * RevisionStatus communicates the observed state of the Revision (from the controller). + */ + export interface Schema$RevisionStatus { + /** + * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. As a Revision is being prepared, it will incrementally update conditions. Revision-specific conditions include: * "ResourcesAvailable": True when underlying resources have been provisioned. * "ContainerHealthy": True when the Revision readiness check completes. * "Active": True when the Revision may receive traffic. + */ + conditions?: Schema$GoogleCloudRunV1Condition[]; + /** + * ImageDigest holds the resolved digest for the image specified within .Spec.Container.Image. The digest is resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object. + */ + imageDigest?: string | null; + /** + * Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config. +optional + */ + logUrl?: string | null; + /** + * ObservedGeneration is the 'Generation' of the Revision that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False. + */ + observedGeneration?: number | null; + /** + * Not currently used by Cloud Run. + */ + serviceName?: string | null; + } + /** + * RevisionTemplateSpec describes the data a revision should have when created from a template. Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190 + */ + export interface Schema$RevisionTemplate { + /** + * Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. To set minimum instances for this revision, use the "autoscaling.knative.dev/minScale" annotation key. To set maximum instances for this revision, use the "autoscaling.knative.dev/maxScale" annotation key. To set Cloud SQL connections for the revision, use the "run.googleapis.com/cloudsql-instances" annotation key. + */ + metadata?: Schema$ObjectMeta; + /** + * RevisionSpec holds the desired state of the Revision (from the client). + */ + spec?: Schema$RevisionSpec; + } + /** + * Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for "latest ready" revision changes, and smoothly rolling out latest revisions. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route Cloud Run currently supports referencing a single Configuration to automatically deploy the "latest ready" Revision from that Configuration. + */ + export interface Schema$Route { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * The kind of this resource, in this case always "Route". + */ + kind?: string | null; + /** + * Metadata associated with this Route, including name, namespace, labels, and annotations. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec holds the desired state of the Route (from the client). + */ + spec?: Schema$RouteSpec; + /** + * Status communicates the observed state of the Route (from the controller). + */ + status?: Schema$RouteStatus; + } + /** + * RouteSpec holds the desired state of the Route (from the client). + */ + export interface Schema$RouteSpec { + /** + * Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. Cloud Run currently supports a single configurationName. + */ + traffic?: Schema$TrafficTarget[]; + } + /** + * RouteStatus communicates the observed state of the Route (from the controller). + */ + export interface Schema$RouteStatus { + /** + * Similar to url, information on where the service is available on HTTP. + */ + address?: Schema$Addressable; + /** + * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. + */ + conditions?: Schema$GoogleCloudRunV1Condition[]; + /** + * ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. Note that providing a trafficTarget that only has a configurationName will result in a Route that does not increment either its metadata.generation or its observedGeneration, as new "latest ready" revisions from the Configuration are processed without an update to the Route's spec. + */ + observedGeneration?: number | null; + /** + * Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. + */ + traffic?: Schema$TrafficTarget[]; + /** + * URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form: https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app + */ + url?: string | 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. + */ + export interface Schema$SecretEnvSource { + /** + * This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. + */ + localObjectReference?: Schema$LocalObjectReference; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The Secret to select from. + */ + name?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the Secret must be defined + */ + optional?: boolean | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported SecretKeySelector selects a key of a Secret. + */ + export interface Schema$SecretKeySelector { + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The key of the secret to select from. Must be a valid secret key. + */ + key?: string | null; + /** + * This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. + */ + localObjectReference?: Schema$LocalObjectReference; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The name of the secret in the pod's namespace to select from. + */ + name?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the Secret or its key must be defined + */ + optional?: boolean | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. + */ + export interface Schema$SecretVolumeSource { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + */ + defaultMode?: number | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. + */ + items?: Schema$KeyToPath[]; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the Secret or its keys must be defined. + */ + optional?: boolean | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Name of the secret in the container's namespace to use. + */ + secretName?: string | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + */ + export interface Schema$SecurityContext { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + */ + runAsUser?: number | null; + } + /** + * Service acts as a top-level container that manages a set of Routes and Configurations which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets). The Service's controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own. See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service + */ + export interface Schema$Service { + /** + * The API version for this call such as "serving.knative.dev/v1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case "Service". + */ + kind?: string | null; + /** + * Metadata associated with this Service, including name, namespace, labels, and annotations. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec holds the desired state of the Service (from the client). + */ + spec?: Schema$ServiceSpec; + /** + * Status communicates the observed state of the Service (from the controller). + */ + status?: Schema$ServiceStatus; + } + /** + * ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). + */ + export interface Schema$ServiceSpec { + /** + * Template holds the latest specification for the Revision to be stamped out. + */ + template?: Schema$RevisionTemplate; + /** + * Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. + */ + traffic?: Schema$TrafficTarget[]; + } + /** + * The current state of the Service. Output only. + */ + export interface Schema$ServiceStatus { + /** + * From RouteStatus. Similar to url, information on where the service is available on HTTP. + */ + address?: Schema$Addressable; + /** + * Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Service-specific conditions include: * "ConfigurationsReady": true when the underlying Configuration is ready. * "RoutesReady": true when the underlying Route is ready. * "Ready": true when both the underlying Route and Configuration are ready. + */ + conditions?: Schema$GoogleCloudRunV1Condition[]; + /** + * From ConfigurationStatus. LatestCreatedRevisionName is the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName. + */ + latestCreatedRevisionName?: string | null; + /** + * From ConfigurationStatus. LatestReadyRevisionName holds the name of the latest Revision stamped out from this Service's Configuration that has had its "Ready" condition become "True". + */ + latestReadyRevisionName?: string | null; + /** + * ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. + */ + observedGeneration?: number | null; + /** + * From RouteStatus. Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed. + */ + traffic?: Schema$TrafficTarget[]; + /** + * From RouteStatus. URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app + */ + url?: string | 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; + } + /** + * Status is a return value for calls that don't return other objects + */ + export interface Schema$Status { + /** + * Suggested HTTP return code for this status, 0 if not set. +optional + */ + code?: number | null; + /** + * Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. +optional + */ + details?: Schema$StatusDetails; + /** + * A human-readable description of the status of this operation. +optional + */ + message?: string | null; + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional + */ + metadata?: Schema$ListMeta; + /** + * A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. +optional + */ + reason?: string | null; + /** + * Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional + */ + status?: string | null; + } + /** + * StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. + */ + export interface Schema$StatusCause { + /** + * The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items" +optional + */ + field?: string | null; + /** + * A human-readable description of the cause of the error. This field may be presented as-is to a reader. +optional + */ + message?: string | null; + /** + * A machine-readable description of the cause of the error. If this value is empty there is no information available. +optional + */ + reason?: string | null; + } + /** + * StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. + */ + export interface Schema$StatusDetails { + /** + * The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. +optional + */ + causes?: Schema$StatusCause[]; + /** + * The group attribute of the resource associated with the status StatusReason. +optional + */ + group?: string | null; + /** + * The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional + */ + kind?: string | null; + /** + * The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). +optional + */ + name?: string | null; + /** + * If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. +optional + */ + retryAfterSeconds?: number | null; + /** + * UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional + */ + uid?: string | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported TCPSocketAction describes an action based on opening a socket + */ + export interface Schema$TCPSocketAction { + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Optional: Host name to connect to, defaults to the pod IP. + */ + host?: string | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + */ + port?: Schema$IntOrString; + } + /** + * 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; + } + /** + * TrafficTarget holds a single entry of the routing table for a Route. + */ + export interface Schema$TrafficTarget { + /** + * ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName. + */ + configurationName?: string | null; + /** + * LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty. +optional + */ + latestRevision?: boolean | null; + /** + * Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified. Cloud Run currently requires 100 percent for a single ConfigurationName TrafficTarget entry. + */ + percent?: number | null; + /** + * RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName. Providing RevisionName in spec is not currently supported by Cloud Run. + */ + revisionName?: string | null; + /** + * Tag is optionally used to expose a dedicated url for referencing this target exclusively. Not currently supported in Cloud Run. +optional + */ + tag?: string | null; + /** + * Output only. URL displays the URL for accessing tagged traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc. Not currently supported in Cloud Run. + */ + url?: string | null; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Volume represents a named volume in a container. + */ + export interface Schema$Volume { + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported + */ + configMap?: Schema$ConfigMapVolumeSource; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Volume's name. + */ + name?: string | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported + */ + secret?: Schema$SecretVolumeSource; + } + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported VolumeMount describes a mounting of a Volume within a container. + */ + export interface Schema$VolumeMount { + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Path within the container at which the volume should be mounted. Must not contain ':'. + */ + mountPath?: string | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported This must match the Name of a Volume. + */ + name?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Only true is accepted. Defaults to true. + */ + readOnly?: boolean | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + */ + subPath?: string | null; + } + + export class Resource$Namespaces { + context: APIRequestContext; + authorizeddomains: Resource$Namespaces$Authorizeddomains; + autodomainmappings: Resource$Namespaces$Autodomainmappings; + configurations: Resource$Namespaces$Configurations; + domainmappings: Resource$Namespaces$Domainmappings; + revisions: Resource$Namespaces$Revisions; + routes: Resource$Namespaces$Routes; + services: Resource$Namespaces$Services; + constructor(context: APIRequestContext) { + this.context = context; + this.authorizeddomains = new Resource$Namespaces$Authorizeddomains( + this.context + ); + this.autodomainmappings = new Resource$Namespaces$Autodomainmappings( + this.context + ); + this.configurations = new Resource$Namespaces$Configurations( + this.context + ); + this.domainmappings = new Resource$Namespaces$Domainmappings( + 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); + } + } + + export class Resource$Namespaces$Authorizeddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.authorizeddomains.list + * @desc List authorized domains. + * @alias run.namespaces.authorizeddomains.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Maximum results to return per page. + * @param {string=} params.pageToken Continuation token for fetching the next page of results. + * @param {string} params.parent Name of the parent Application resource. Example: `apps/myapp`. + * @param {object} [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$Authorizeddomains$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Authorizeddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Authorizeddomains$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Authorizeddomains$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Authorizeddomains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Authorizeddomains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/apis/domains.cloudrun.com/v1/{+parent}/authorizeddomains' + ).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$Authorizeddomains$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum results to return per page. + */ + pageSize?: number; + /** + * Continuation token for fetching the next page of results. + */ + pageToken?: string; + /** + * Name of the parent Application resource. Example: `apps/myapp`. + */ + parent?: string; + } + + export class Resource$Namespaces$Autodomainmappings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.autodomainmappings.create + * @desc Creates a new auto domain mapping. + * @alias run.namespaces.autodomainmappings.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this auto domain mapping should be created. + * @param {().AutoDomainMapping} params.resource Request body data + * @param {object} [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$Autodomainmappings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Autodomainmappings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Namespaces$Autodomainmappings$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Namespaces$Autodomainmappings$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Autodomainmappings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Autodomainmappings$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/domains.cloudrun.com/v1/{+parent}/autodomainmappings' + ).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.autodomainmappings.delete + * @desc Delete an auto domain mapping. + * @alias run.namespaces.autodomainmappings.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 auto domain mapping being deleted. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Autodomainmappings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Autodomainmappings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Autodomainmappings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Autodomainmappings$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Autodomainmappings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Autodomainmappings$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/domains.cloudrun.com/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); + } + } + + /** + * run.namespaces.autodomainmappings.get + * @desc Get information about an auto domain mapping. + * @alias run.namespaces.autodomainmappings.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the auto domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + get( + params?: Params$Resource$Namespaces$Autodomainmappings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Autodomainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Autodomainmappings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Namespaces$Autodomainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Autodomainmappings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Autodomainmappings$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/domains.cloudrun.com/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.namespaces.autodomainmappings.list + * @desc List auto domain mappings. + * @alias run.namespaces.autodomainmappings.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 auto 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 + */ + list( + params?: Params$Resource$Namespaces$Autodomainmappings$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Autodomainmappings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Autodomainmappings$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Autodomainmappings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Autodomainmappings$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Autodomainmappings$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/apis/domains.cloudrun.com/v1/{+parent}/autodomainmappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * run.namespaces.autodomainmappings.replaceAutoDomainMapping + * @desc Replace an auto domain mapping. 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.autodomainmappings.replaceAutoDomainMapping + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the auto domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().AutoDomainMapping} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceAutoDomainMapping( + params?: Params$Resource$Namespaces$Autodomainmappings$Replaceautodomainmapping, + options?: MethodOptions + ): GaxiosPromise; + replaceAutoDomainMapping( + params: Params$Resource$Namespaces$Autodomainmappings$Replaceautodomainmapping, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceAutoDomainMapping( + params: Params$Resource$Namespaces$Autodomainmappings$Replaceautodomainmapping, + callback: BodyResponseCallback + ): void; + replaceAutoDomainMapping( + callback: BodyResponseCallback + ): void; + replaceAutoDomainMapping( + paramsOrCallback?: + | Params$Resource$Namespaces$Autodomainmappings$Replaceautodomainmapping + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Autodomainmappings$Replaceautodomainmapping; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Autodomainmappings$Replaceautodomainmapping; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/apis/domains.cloudrun.com/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$Namespaces$Autodomainmappings$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 auto domain mapping should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutoDomainMapping; + } + export interface Params$Resource$Namespaces$Autodomainmappings$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 auto domain mapping being deleted. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Autodomainmappings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the auto domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + } + export interface Params$Resource$Namespaces$Autodomainmappings$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 auto 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 interface Params$Resource$Namespaces$Autodomainmappings$Replaceautodomainmapping + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the auto domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutoDomainMapping; + } + + export class Resource$Namespaces$Configurations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.configurations.create + * @desc Create a configuration. + * @alias run.namespaces.configurations.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The namespace in which the configuration should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Configuration} params.resource Request body data + * @param {object} [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$Configurations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Configurations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Namespaces$Configurations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Namespaces$Configurations$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Configurations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Configurations$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/serving.knative.dev/v1/{+parent}/configurations' + ).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.configurations.delete + * @desc delete a configuration. This will cause the configuration to delete all child revisions. Prior to calling this, any route referencing the configuration (or revision from the configuration) must be deleted. + * @alias run.namespaces.configurations.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 configuration to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Configurations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Configurations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Configurations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Configurations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Configurations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Configurations$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/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); + } + } + + /** + * run.namespaces.configurations.get + * @desc Get information about a configuration. + * @alias run.namespaces.configurations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the configuration to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + get( + params?: Params$Resource$Namespaces$Configurations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Configurations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Configurations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Namespaces$Configurations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Configurations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Configurations$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/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.namespaces.configurations.list + * @desc List configurations. + * @alias run.namespaces.configurations.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 namespace from which the configurations should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Namespaces$Configurations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Configurations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Configurations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Configurations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Configurations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Configurations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/serving.knative.dev/v1/{+parent}/configurations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.configurations.replaceConfiguration + * @desc Replace a configuration. 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.configurations.replaceConfiguration + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the configuration being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Configuration} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceConfiguration( + params?: Params$Resource$Namespaces$Configurations$Replaceconfiguration, + options?: MethodOptions + ): GaxiosPromise; + replaceConfiguration( + params: Params$Resource$Namespaces$Configurations$Replaceconfiguration, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceConfiguration( + params: Params$Resource$Namespaces$Configurations$Replaceconfiguration, + callback: BodyResponseCallback + ): void; + replaceConfiguration( + callback: BodyResponseCallback + ): void; + replaceConfiguration( + paramsOrCallback?: + | Params$Resource$Namespaces$Configurations$Replaceconfiguration + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Configurations$Replaceconfiguration; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Configurations$Replaceconfiguration; + 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/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$Namespaces$Configurations$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The namespace in which the configuration should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Configuration; + } + export interface Params$Resource$Namespaces$Configurations$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 configuration to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Configurations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the configuration to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + } + export interface Params$Resource$Namespaces$Configurations$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 namespace from which the configurations should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Namespaces$Configurations$Replaceconfiguration + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the configuration being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Configuration; + } + + export class Resource$Namespaces$Domainmappings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.domainmappings.create + * @desc Create a new domain mapping. + * @alias run.namespaces.domainmappings.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().DomainMapping} params.resource Request body data + * @param {object} [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, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Domainmappings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Namespaces$Domainmappings$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Namespaces$Domainmappings$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Domainmappings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/domains.cloudrun.com/v1/{+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.namespaces.domainmappings.delete + * @desc Delete a domain mapping. + * @alias run.namespaces.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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Domainmappings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Domainmappings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Domainmappings$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Domainmappings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/domains.cloudrun.com/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); + } + } + + /** + * run.namespaces.domainmappings.get + * @desc Get information about a domain mapping. + * @alias run.namespaces.domainmappings.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the domain mapping to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + get( + params?: Params$Resource$Namespaces$Domainmappings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Domainmappings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Namespaces$Domainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Domainmappings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Domainmappings$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/domains.cloudrun.com/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.namespaces.domainmappings.list + * @desc List domain mappings. + * @alias run.namespaces.domainmappings.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 namespace from which the domain mappings should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Namespaces$Domainmappings$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Domainmappings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Domainmappings$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Domainmappings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Domainmappings$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Domainmappings$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/domains.cloudrun.com/v1/{+parent}/domainmappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.domainmappings.replaceDomainMapping + * @desc Replace a domain mapping. 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.domainmappings.replaceDomainMapping + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().DomainMapping} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceDomainMapping( + params?: Params$Resource$Namespaces$Domainmappings$Replacedomainmapping, + options?: MethodOptions + ): GaxiosPromise; + replaceDomainMapping( + params: Params$Resource$Namespaces$Domainmappings$Replacedomainmapping, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceDomainMapping( + params: Params$Resource$Namespaces$Domainmappings$Replacedomainmapping, + callback: BodyResponseCallback + ): void; + replaceDomainMapping( + callback: BodyResponseCallback + ): void; + replaceDomainMapping( + paramsOrCallback?: + | Params$Resource$Namespaces$Domainmappings$Replacedomainmapping + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Domainmappings$Replacedomainmapping; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Domainmappings$Replacedomainmapping; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/apis/domains.cloudrun.com/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$Namespaces$Domainmappings$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Domainmappings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the domain mapping to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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 namespace from which the domain mappings should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Namespaces$Domainmappings$Replacedomainmapping + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DomainMapping; + } + + export class Resource$Namespaces$Revisions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.revisions.delete + * @desc 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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Revisions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + 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/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); + } + } + + /** + * run.namespaces.revisions.get + * @desc 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 to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + 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/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.namespaces.revisions.list + * @desc List revisions. + * @alias run.namespaces.revisions.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 namespace from which the revisions should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Namespaces$Revisions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Revisions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Revisions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Revisions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Revisions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Revisions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/serving.knative.dev/v1/{+parent}/revisions' + ).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$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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Revisions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the revision to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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 namespace from which the revisions should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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.create + * @desc Create a route. + * @alias run.namespaces.routes.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The namespace in which the route should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Route} params.resource Request body data + * @param {object} [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$Routes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Routes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Namespaces$Routes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Namespaces$Routes$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Routes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Routes$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/serving.knative.dev/v1/{+parent}/routes' + ).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.routes.delete + * @desc Delete a route. This will cause the route to stop serving traffic. + * @alias run.namespaces.routes.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 route to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Routes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Routes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Routes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Routes$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Routes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Routes$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/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); + } + } + + /** + * run.namespaces.routes.get + * @desc 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 route to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + 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/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.namespaces.routes.list + * @desc 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 namespace from which the routes should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Namespaces$Routes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Routes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Routes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Routes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Routes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/serving.knative.dev/v1/{+parent}/routes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.routes.replaceRoute + * @desc Replace a route. 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.routes.replaceRoute + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the route being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Route} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceRoute( + params?: Params$Resource$Namespaces$Routes$Replaceroute, + options?: MethodOptions + ): GaxiosPromise; + replaceRoute( + params: Params$Resource$Namespaces$Routes$Replaceroute, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceRoute( + params: Params$Resource$Namespaces$Routes$Replaceroute, + callback: BodyResponseCallback + ): void; + replaceRoute(callback: BodyResponseCallback): void; + replaceRoute( + paramsOrCallback?: + | Params$Resource$Namespaces$Routes$Replaceroute + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Routes$Replaceroute; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Routes$Replaceroute; + 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/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$Namespaces$Routes$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The namespace in which the route should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Route; + } + export interface Params$Resource$Namespaces$Routes$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 route to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Routes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the route to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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 namespace from which the routes should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Namespaces$Routes$Replaceroute + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the route being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Route; + } + + export class Resource$Namespaces$Services { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.services.create + * @desc Create a service. + * @alias run.namespaces.services.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Service} params.resource Request body data + * @param {object} [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, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Services$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Namespaces$Services$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Namespaces$Services$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Services$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/serving.knative.dev/v1/{+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.namespaces.services.delete + * @desc 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 service to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Services$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Services$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Services$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Services$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Services$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Services$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/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); + } + } + + /** + * run.namespaces.services.get + * @desc 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 to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + 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 { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Services$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/serving.knative.dev/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.namespaces.services.list + * @desc List services. + * @alias run.namespaces.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 namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Namespaces$Services$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Services$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Services$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Services$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Services$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$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 + '/apis/serving.knative.dev/v1/{+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.namespaces.services.replaceService + * @desc 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 service being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Service} params.resource Request body data + * @param {object} [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, + options?: MethodOptions + ): 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$Services$Replaceservice + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Services$Replaceservice; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Services$Replaceservice; + 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/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$Namespaces$Services$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Services$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the service to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + } + export interface Params$Resource$Namespaces$Services$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 namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$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. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + authorizeddomains: Resource$Projects$Locations$Authorizeddomains; + autodomainmappings: Resource$Projects$Locations$Autodomainmappings; + configurations: Resource$Projects$Locations$Configurations; + domainmappings: Resource$Projects$Locations$Domainmappings; + revisions: Resource$Projects$Locations$Revisions; + routes: Resource$Projects$Locations$Routes; + services: Resource$Projects$Locations$Services; + constructor(context: APIRequestContext) { + this.context = context; + this.authorizeddomains = new Resource$Projects$Locations$Authorizeddomains( + this.context + ); + this.autodomainmappings = new Resource$Projects$Locations$Autodomainmappings( + this.context + ); + this.configurations = new Resource$Projects$Locations$Configurations( + this.context + ); + this.domainmappings = new Resource$Projects$Locations$Domainmappings( + 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); + } + + /** + * 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. + * @alias run.projects.locations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The resource that owns the locations collection, if applicable. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Authorizeddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.authorizeddomains.list + * @desc List authorized domains. + * @alias run.projects.locations.authorizeddomains.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Maximum results to return per page. + * @param {string=} params.pageToken Continuation token for fetching the next page of results. + * @param {string} params.parent Name of the parent Application resource. Example: `apps/myapp`. + * @param {object} [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$Authorizeddomains$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizeddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizeddomains$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizeddomains$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizeddomains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Authorizeddomains$List; + 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}/authorizeddomains').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$Authorizeddomains$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum results to return per page. + */ + pageSize?: number; + /** + * Continuation token for fetching the next page of results. + */ + pageToken?: string; + /** + * Name of the parent Application resource. Example: `apps/myapp`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Autodomainmappings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.autodomainmappings.create + * @desc Creates a new auto domain mapping. + * @alias run.projects.locations.autodomainmappings.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this auto domain mapping should be created. + * @param {().AutoDomainMapping} params.resource Request body data + * @param {object} [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$Autodomainmappings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Autodomainmappings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Autodomainmappings$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autodomainmappings$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autodomainmappings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Autodomainmappings$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}/autodomainmappings').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.autodomainmappings.delete + * @desc Delete an auto domain mapping. + * @alias run.projects.locations.autodomainmappings.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 auto domain mapping being deleted. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Autodomainmappings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Autodomainmappings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Autodomainmappings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autodomainmappings$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autodomainmappings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Autodomainmappings$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.autodomainmappings.get + * @desc Get information about an auto domain mapping. + * @alias run.projects.locations.autodomainmappings.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the auto domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + get( + params?: Params$Resource$Projects$Locations$Autodomainmappings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Autodomainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Autodomainmappings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autodomainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autodomainmappings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Autodomainmappings$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.autodomainmappings.list + * @desc List auto domain mappings. + * @alias run.projects.locations.autodomainmappings.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 auto 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 + */ + list( + params?: Params$Resource$Projects$Locations$Autodomainmappings$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Autodomainmappings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autodomainmappings$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autodomainmappings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autodomainmappings$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Autodomainmappings$List; + 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}/autodomainmappings').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.autodomainmappings.replaceAutoDomainMapping + * @desc Replace an auto domain mapping. 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.autodomainmappings.replaceAutoDomainMapping + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the auto domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().AutoDomainMapping} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceAutoDomainMapping( + params?: Params$Resource$Projects$Locations$Autodomainmappings$Replaceautodomainmapping, + options?: MethodOptions + ): GaxiosPromise; + replaceAutoDomainMapping( + params: Params$Resource$Projects$Locations$Autodomainmappings$Replaceautodomainmapping, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceAutoDomainMapping( + params: Params$Resource$Projects$Locations$Autodomainmappings$Replaceautodomainmapping, + callback: BodyResponseCallback + ): void; + replaceAutoDomainMapping( + callback: BodyResponseCallback + ): void; + replaceAutoDomainMapping( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autodomainmappings$Replaceautodomainmapping + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autodomainmappings$Replaceautodomainmapping; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Autodomainmappings$Replaceautodomainmapping; + 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$Autodomainmappings$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 auto domain mapping should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutoDomainMapping; + } + export interface Params$Resource$Projects$Locations$Autodomainmappings$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 auto domain mapping being deleted. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Autodomainmappings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the auto domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Autodomainmappings$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 auto 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 interface Params$Resource$Projects$Locations$Autodomainmappings$Replaceautodomainmapping + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the auto domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutoDomainMapping; + } + + export class Resource$Projects$Locations$Configurations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.configurations.create + * @desc Create a configuration. + * @alias run.projects.locations.configurations.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The namespace in which the configuration should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Configuration} params.resource Request body data + * @param {object} [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$Configurations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Configurations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Configurations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Configurations$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Configurations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Configurations$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}/configurations').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.configurations.delete + * @desc delete a configuration. This will cause the configuration to delete all child revisions. Prior to calling this, any route referencing the configuration (or revision from the configuration) must be deleted. + * @alias run.projects.locations.configurations.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 configuration to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Configurations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Configurations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Configurations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Configurations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Configurations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Configurations$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.configurations.get + * @desc 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 configuration to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + get( + params?: Params$Resource$Projects$Locations$Configurations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Configurations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Configurations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Configurations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Configurations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Configurations$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.configurations.list + * @desc List configurations. + * @alias run.projects.locations.configurations.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 namespace from which the configurations should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Configurations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Configurations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Configurations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Configurations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Configurations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Configurations$List; + 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}/configurations').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.configurations.replaceConfiguration + * @desc Replace a configuration. 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.configurations.replaceConfiguration + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the configuration being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Configuration} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceConfiguration( + params?: Params$Resource$Projects$Locations$Configurations$Replaceconfiguration, + options?: MethodOptions + ): GaxiosPromise; + replaceConfiguration( + params: Params$Resource$Projects$Locations$Configurations$Replaceconfiguration, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceConfiguration( + params: Params$Resource$Projects$Locations$Configurations$Replaceconfiguration, + callback: BodyResponseCallback + ): void; + replaceConfiguration( + callback: BodyResponseCallback + ): void; + replaceConfiguration( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Configurations$Replaceconfiguration + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Configurations$Replaceconfiguration; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Configurations$Replaceconfiguration; + 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$Configurations$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The namespace in which the configuration should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Configuration; + } + export interface Params$Resource$Projects$Locations$Configurations$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 configuration to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the configuration to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Configurations$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 namespace from which the configurations should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Configurations$Replaceconfiguration + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the configuration being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Configuration; + } + + export class Resource$Projects$Locations$Domainmappings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.domainmappings.create + * @desc Create a new domain mapping. + * @alias run.projects.locations.domainmappings.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().DomainMapping} params.resource Request body data + * @param {object} [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 + '/v1/{+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 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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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 + '/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); + } + } + + /** + * run.projects.locations.domainmappings.get + * @desc 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 to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + get( + params?: Params$Resource$Projects$Locations$Domainmappings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Domainmappings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$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.domainmappings.list + * @desc List domain mappings. + * @alias run.projects.locations.domainmappings.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 namespace from which the domain mappings should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Domainmappings$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Domainmappings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Domainmappings$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$List; + 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}/domainmappings').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.domainmappings.replaceDomainMapping + * @desc Replace a domain mapping. 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.domainmappings.replaceDomainMapping + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().DomainMapping} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceDomainMapping( + params?: Params$Resource$Projects$Locations$Domainmappings$Replacedomainmapping, + options?: MethodOptions + ): GaxiosPromise; + replaceDomainMapping( + params: Params$Resource$Projects$Locations$Domainmappings$Replacedomainmapping, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceDomainMapping( + params: Params$Resource$Projects$Locations$Domainmappings$Replacedomainmapping, + callback: BodyResponseCallback + ): void; + replaceDomainMapping( + callback: BodyResponseCallback + ): void; + replaceDomainMapping( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$Replacedomainmapping + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$Replacedomainmapping; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Replacedomainmapping; + 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$Domainmappings$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Domainmappings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the domain mapping to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$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 namespace from which the domain mappings should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Domainmappings$Replacedomainmapping + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the domain mapping being retrieved. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DomainMapping; + } + + export class Resource$Projects$Locations$Revisions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.revisions.delete + * @desc 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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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 + '/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); + } + } + + /** + * run.projects.locations.revisions.get + * @desc Get information about a revision. + * @alias run.projects.locations.revisions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the revision to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + get( + params?: Params$Resource$Projects$Locations$Revisions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Revisions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Revisions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Revisions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Revisions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$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 + '/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.revisions.list + * @desc List revisions. + * @alias run.projects.locations.revisions.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 namespace from which the revisions should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Revisions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Revisions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Revisions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Revisions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Revisions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Revisions$List; + 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}/revisions').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$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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Revisions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the revision to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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; + + /** + * 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 namespace from which the revisions should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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.routes.create + * @desc Create a route. + * @alias run.projects.locations.routes.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The namespace in which the route should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Route} params.resource Request body data + * @param {object} [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$Routes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Routes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Routes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Routes$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}/routes').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.routes.delete + * @desc Delete a route. This will cause the route to stop serving traffic. + * @alias run.projects.locations.routes.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 route to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Routes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Routes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Routes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Routes$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.routes.get + * @desc Get information about a route. + * @alias run.projects.locations.routes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the route to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + get( + params?: Params$Resource$Projects$Locations$Routes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Routes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Routes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$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 + '/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.routes.list + * @desc List routes. + * @alias run.projects.locations.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 namespace from which the routes should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Routes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Routes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Routes$List; + 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}/routes').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.routes.replaceRoute + * @desc Replace a route. 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.routes.replaceRoute + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the route being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Route} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + replaceRoute( + params?: Params$Resource$Projects$Locations$Routes$Replaceroute, + options?: MethodOptions + ): GaxiosPromise; + replaceRoute( + params: Params$Resource$Projects$Locations$Routes$Replaceroute, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceRoute( + params: Params$Resource$Projects$Locations$Routes$Replaceroute, + callback: BodyResponseCallback + ): void; + replaceRoute(callback: BodyResponseCallback): void; + replaceRoute( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Routes$Replaceroute + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Routes$Replaceroute; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Routes$Replaceroute; + 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$Routes$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The namespace in which the route should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Route; + } + export interface Params$Resource$Projects$Locations$Routes$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 route to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Routes$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the route to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$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 namespace from which the routes should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$Routes$Replaceroute + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the route being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Route; + } + + export class Resource$Projects$Locations$Services { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.services.create + * @desc Create a service. + * @alias run.projects.locations.services.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Service} params.resource Request body data + * @param {object} [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 + '/v1/{+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 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 service to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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$Services$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Services$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Services$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.get + * @desc 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 to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the 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 + */ + 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 + '/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.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 + '/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); + } + } + /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + * run.projects.locations.services.list + * @desc 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 namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @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 */ - name?: string | null; - } + 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; - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$List; + options = {}; + } - export class Resource$Projects$Locations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/services').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } } /** - * run.projects.locations.get - * @desc Gets information about a location. - * @alias run.projects.locations.get + * run.projects.locations.services.replaceService + * @desc 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 Resource name for the location. + * @param {string} params.name The name of the service being replaced. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + * @param {().Service} params.resource Request body data * @param {object} [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, + replaceService( + params?: Params$Resource$Projects$Locations$Services$Replaceservice, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + replaceService( + params: Params$Resource$Projects$Locations$Services$Replaceservice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$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$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$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$Get; + params = {} as Params$Resource$Projects$Locations$Services$Replaceservice; options = {}; } @@ -224,7 +7571,7 @@ export namespace run_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PUT', }, options ), @@ -234,59 +7581,132 @@ export namespace run_v1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.list - * @desc Lists information about the supported locations for this service. - * @alias run.projects.locations.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.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 {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$List, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Services$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Services$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Services$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.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); + } + } + + /** + * 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.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Services$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Services$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Services$Testiampermissions, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Services$Testiampermissions + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Projects$Locations$Services$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Projects$Locations$Services$Testiampermissions; options = {}; } @@ -299,28 +7719,31 @@ export namespace run_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + 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$Get + export interface Params$Resource$Projects$Locations$Services$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -328,11 +7751,40 @@ export namespace run_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for the location. + * The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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 to delete. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. */ 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$List + export interface Params$Resource$Projects$Locations$Services$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -340,20 +7792,115 @@ export namespace run_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The standard list filter. + * The name of the service to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Services$Getiampolicy + extends StandardParameters { /** - * The resource that owns the locations collection, if applicable. + * 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 + */ + 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 namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. + */ + 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$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. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number. */ name?: string; + /** - * The standard list page size. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$Service; + } + export interface Params$Resource$Projects$Locations$Services$Setiampolicy + extends StandardParameters { /** - * The standard list page token. + * Auth client or API Key for the request */ - pageToken?: string; + 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; } } diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index a136a0b9ce6..4b29849cdd8 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -198,16 +198,58 @@ export namespace run_v1alpha1 { */ drop?: string[] | null; } + /** + * CloudEventOverrides defines arguments for a Source that control the output format of the CloudEvents produced by the Source. + */ + export interface Schema$CloudEventOverrides { + /** + * Extensions specify what attribute are added or overridden on the outbound event. Each `Extensions` key-value pair are set on the event as an attribute extension independently. +optional + */ + extensions?: {[key: string]: string} | null; + } + /** + * Condition defines a generic condition for a Resource + */ + export interface Schema$Condition { + /** + * Optional. Last time the condition transitioned from one status to another. + */ + lastTransitionTime?: string | null; + /** + * Optional. Human readable message indicating details about the current status. + */ + message?: string | null; + /** + * Optional. One-word CamelCase reason for the condition's last transition. + */ + reason?: string | null; + /** + * Optional. How to interpret failures of this condition, one of Error, Warning, Info + */ + severity?: string | null; + /** + * Status of the condition, one of True, False, Unknown. + */ + status?: string | null; + /** + * type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + */ + type?: string | null; + } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ export interface Schema$ConfigMapEnvSource { /** - * The ConfigMap to select from. + * This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. */ localObjectReference?: Schema$LocalObjectReference; /** - * Specify whether the ConfigMap must be defined +optional + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The ConfigMap to select from. + */ + name?: string | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the ConfigMap must be defined +optional */ optional?: boolean | null; } @@ -220,9 +262,13 @@ export namespace run_v1alpha1 { */ key?: string | null; /** - * Cloud Run fully managed: not supported Cloud Run on GKE: supported The ConfigMap to select from. + * This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. */ localObjectReference?: Schema$LocalObjectReference; + /** + * Cloud Run fully managed: not supported Cloud Run on GKE: supported The ConfigMap to select from. + */ + name?: string | null; /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported Specify whether the ConfigMap or its key must be defined +optional */ @@ -455,6 +501,16 @@ export namespace run_v1alpha1 { */ protocol?: string | null; } + export interface Schema$Destination { + /** + * ObjectReference points to an Addressable. + optional + */ + ref?: Schema$ObjectReference; + /** + * URI is for direct URI Designations or used with the resulting URL from Addressable ObjectReference. If used with an ObjectReference, will be appended to the path of the resulting URL from the Addressable. + optional + */ + uri?: string | null; + } /** * Resource to hold the state and status of a user's domain mapping. */ @@ -696,23 +752,6 @@ export namespace run_v1alpha1 { */ title?: 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$GoogleRpcStatus { - /** - * 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; - } /** * Handler defines a specific action that should be taken */ @@ -866,10 +905,6 @@ export namespace run_v1alpha1 { * Metadata associated with this Configuration list. */ metadata?: Schema$ListMeta; - /** - * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. - */ - regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ @@ -896,9 +931,9 @@ export namespace run_v1alpha1 { */ metadata?: Schema$ListMeta; /** - * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. + * Locations that could not be reached. */ - regionDetails?: {[key: string]: Schema$RegionDetails} | null; + unreachable?: string[] | null; } /** * ListEventTypesResponse is a list of EventType resources. @@ -920,10 +955,6 @@ export namespace run_v1alpha1 { * Metadata associated with this EventType list. */ metadata?: Schema$ListMeta; - /** - * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. - */ - regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ @@ -959,6 +990,31 @@ export namespace run_v1alpha1 { */ selfLink?: string | null; } + /** + * ListPubSubsResponse is a list of PubSub resources. + */ + export interface Schema$ListPubSubsResponse { + /** + * The API version for this call such as "events.cloud.google.com/v1alpha1". + */ + apiVersion?: string | null; + /** + * List of PubSubs. + */ + items?: Schema$PubSub[]; + /** + * The kind of this resource, in this case "PubSubList". + */ + kind?: string | null; + /** + * Metadata associated with this PubSub list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * ListRevisionsResponse is a list of Revision resources. */ @@ -979,10 +1035,6 @@ export namespace run_v1alpha1 { * Metadata associated with this revision list. */ metadata?: Schema$ListMeta; - /** - * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. - */ - regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ @@ -1008,10 +1060,6 @@ export namespace run_v1alpha1 { * Metadata associated with this Route list. */ metadata?: Schema$ListMeta; - /** - * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. - */ - regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ @@ -1037,10 +1085,6 @@ export namespace run_v1alpha1 { * Metadata associated with this Service list. */ metadata?: Schema$ListMeta; - /** - * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. - */ - regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ @@ -1066,10 +1110,6 @@ export namespace run_v1alpha1 { * Metadata associated with this Trigger list. */ metadata?: Schema$ListMeta; - /** - * Details for the regions used during a global call including any failures. This is not populated when targeting a specific region. - */ - regionDetails?: {[key: string]: Schema$RegionDetails} | null; /** * Locations that could not be reached. */ @@ -1241,7 +1281,7 @@ export namespace run_v1alpha1 { uid?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -1249,15 +1289,15 @@ export namespace run_v1alpha1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -1290,23 +1330,94 @@ 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 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 + * The desired state of the PubSub. */ - export interface Schema$Quantity { + export interface Schema$PubSubSpec { /** - * Stringified version of the quantity, e.g., "800 MiB". + * 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 */ - string?: string | null; + 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; + /** + * 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; } /** - * Information for a regional call used for a global API. + * 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 */ - export interface Schema$RegionDetails { + export interface Schema$Quantity { /** - * The status indicating why the regional call failed + * Stringified version of the quantity, e.g., "800 MiB". */ - error?: Schema$GoogleRpcStatus; + string?: string | null; } /** * A DNS resource record. @@ -1581,11 +1692,15 @@ export namespace run_v1alpha1 { */ export interface Schema$SecretEnvSource { /** - * The Secret to select from. + * This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. */ localObjectReference?: Schema$LocalObjectReference; /** - * Specify whether the Secret must be defined +optional + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported The Secret to select from. + */ + name?: string | null; + /** + * Cloud Run fully managed: not supported Cloud Run for Anthos: supported Specify whether the Secret must be defined +optional */ optional?: boolean | null; } @@ -1598,9 +1713,13 @@ export namespace run_v1alpha1 { */ key?: string | null; /** - * Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod's namespace to select from. + * This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. */ localObjectReference?: Schema$LocalObjectReference; + /** + * Cloud Run fully managed: not supported Cloud Run on GKE: supported The name of the secret in the pod's namespace to select from. + */ + name?: string | null; /** * Cloud Run fully managed: not supported Cloud Run on GKE: supported Specify whether the Secret or its key must be defined +optional */ @@ -1996,12 +2115,12 @@ export namespace run_v1alpha1 { */ attributes?: {[key: string]: string} | null; /** - * SourceAndType filters events based on exact matches on the CloudEvents type and source attributes. This field has been replaced by the Attributes field. +optional + * SourceAndType is DEPRECATED and replaced by the Attributes field. */ sourceAndType?: Schema$TriggerFilterSourceAndType; } /** - * TriggerFilterSourceAndType filters events based on exact matches on the cloud event's type and source attributes. Only exact matches will pass the filter. + * TriggerFilterSourceAndType is DEPRECATED. Filters are now contained in the map of attributes in TriggerFilter proto. */ export interface Schema$TriggerFilterSourceAndType { source?: string | null; @@ -2111,6 +2230,7 @@ export namespace run_v1alpha1 { 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; @@ -2127,6 +2247,7 @@ export namespace run_v1alpha1 { 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); @@ -3100,56 +3221,128 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Namespaces$Revisions { + export class Resource$Namespaces$Pubsubs { 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.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.resource Request body data + * @param {object} [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 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.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$Revisions$Delete, + params?: Params$Resource$Namespaces$Pubsubs$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Namespaces$Revisions$Delete, + params: Params$Resource$Namespaces$Pubsubs$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Namespaces$Revisions$Delete, + params: Params$Resource$Namespaces$Pubsubs$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$Delete + | Params$Resource$Namespaces$Pubsubs$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Revisions$Delete; + {}) as Params$Resource$Namespaces$Pubsubs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$Delete; + params = {} as Params$Resource$Namespaces$Pubsubs$Delete; options = {}; } @@ -3163,7 +3356,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: 'DELETE', }, @@ -3182,45 +3375,45 @@ export namespace run_v1alpha1 { } /** - * run.namespaces.revisions.get - * @desc Rpc to get information about a revision. - * @alias run.namespaces.revisions.get + * run.namespaces.pubsubs.get + * @desc Rpc to get information about a pubsub. + * @alias run.namespaces.pubsubs.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 pubsub 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, + params?: Params$Resource$Namespaces$Pubsubs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Revisions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Pubsubs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Revisions$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Pubsubs$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Pubsubs$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Revisions$Get; + {}) as Params$Resource$Namespaces$Pubsubs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$Get; + params = {} as Params$Resource$Namespaces$Pubsubs$Get; options = {}; } @@ -3234,7 +3427,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', }, @@ -3246,16 +3439,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.list - * @desc Rpc to list revisions. - * @alias run.namespaces.revisions.list + * run.namespaces.pubsubs.list + * @desc Rpc to list pubsubs. + * @alias run.namespaces.pubsubs.list * @memberOf! () * * @param {object} params Parameters for request @@ -3264,7 +3457,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 pubsubs 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`. @@ -3272,37 +3465,35 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Revisions$List, + params?: Params$Resource$Namespaces$Pubsubs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Revisions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Pubsubs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Revisions$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Pubsubs$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Pubsubs$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$Pubsubs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$List; + params = {} as Params$Resource$Namespaces$Pubsubs$List; options = {}; } @@ -3316,7 +3507,8 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/revisions' + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/pubsubs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3328,19 +3520,108 @@ 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; + * 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 + * @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.resource Request body data + * @param {object} [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, + 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( + paramsOrCallback?: + | Params$Resource$Namespaces$Pubsubs$Replacepubsub + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Pubsubs$Replacepubsub; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Pubsubs$Replacepubsub; + 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$Pubsubs$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 pubsub should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PubSub; + } + export interface Params$Resource$Namespaces$Pubsubs$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Cloud Run currently ignores this parameter. @@ -3351,19 +3632,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the pubsub 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$Pubsubs$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -3371,11 +3648,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 pubsub 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$Pubsubs$List extends StandardParameters { /** * Auth client or API Key for the request @@ -3403,7 +3680,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 pubsubs should be listed. */ parent?: string; /** @@ -3415,53 +3692,145 @@ export namespace run_v1alpha1 { */ watch?: boolean; } + export interface Params$Resource$Namespaces$Pubsubs$Replacepubsub + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - export class Resource$Namespaces$Routes { + /** + * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PubSub; + } + + export class Resource$Namespaces$Revisions { 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.revisions.delete + * @desc Rpc to delete a revision. + * @alias run.namespaces.revisions.delete * @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.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$Revisions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + 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$Routes$Get, + params?: Params$Resource$Namespaces$Revisions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Routes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Revisions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Routes$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Revisions$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Routes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Revisions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Routes$Get; + {}) as Params$Resource$Namespaces$Revisions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Routes$Get; + params = {} as Params$Resource$Namespaces$Revisions$Get; options = {}; } @@ -3487,16 +3856,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.routes.list - * @desc Rpc to list routes. - * @alias run.namespaces.routes.list + * run.namespaces.revisions.list + * @desc Rpc to list revisions. + * @alias run.namespaces.revisions.list * @memberOf! () * * @param {object} params Parameters for request @@ -3505,7 +3874,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 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`. @@ -3513,35 +3882,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Routes$List, + params?: Params$Resource$Namespaces$Revisions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Routes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Revisions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Routes$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$Routes$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$Routes$List; + {}) as Params$Resource$Namespaces$Revisions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Routes$List; + params = {} as Params$Resource$Namespaces$Revisions$List; options = {}; } @@ -3555,7 +3926,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/routes' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/revisions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3567,14 +3938,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$Routes$Get + export interface Params$Resource$Namespaces$Revisions$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -3582,7 +3953,246 @@ 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. + * 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 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 + */ + list( + params?: Params$Resource$Namespaces$Routes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Namespaces$Routes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Namespaces$Routes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Routes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Routes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/routes' + ).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$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; } @@ -4625,6 +5235,7 @@ export namespace run_v1alpha1 { 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; @@ -4643,6 +5254,7 @@ export namespace run_v1alpha1 { this.eventtypes = new Resource$Projects$Locations$Eventtypes( 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); @@ -5712,6 +6324,489 @@ export namespace run_v1alpha1 { watch?: boolean; } + export class Resource$Projects$Locations$Pubsubs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.pubsubs.create + * @desc Creates a new pubsub. + * @alias run.projects.locations.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.resource Request body data + * @param {object} [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, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Pubsubs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Pubsubs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$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 + '/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.projects.locations.pubsubs.delete + * @desc Rpc to delete a pubsub. + * @alias run.projects.locations.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$Projects$Locations$Pubsubs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Pubsubs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Pubsubs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$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 + '/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.pubsubs.get + * @desc Rpc to get information about a pubsub. + * @alias run.projects.locations.pubsubs.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 {object} [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, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Pubsubs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Pubsubs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pubsubs$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.pubsubs.list + * @desc Rpc to list pubsubs. + * @alias run.projects.locations.pubsubs.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 pubsubs 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$Pubsubs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Pubsubs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Pubsubs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pubsubs$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}/pubsubs').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.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 + * @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.resource Request body data + * @param {object} [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, + 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( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pubsubs$Replacepubsub + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pubsubs$Replacepubsub; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pubsubs$Replacepubsub; + 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$Pubsubs$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 pubsub should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PubSub; + } + export interface Params$Resource$Projects$Locations$Pubsubs$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 pubsub 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$Pubsubs$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Pubsubs$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 pubsubs 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$Pubsubs$Replacepubsub + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PubSub; + } + export class Resource$Projects$Locations$Revisions { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/run/v1beta1.ts b/src/apis/run/v1beta1.ts new file mode 100644 index 00000000000..85aa6f8b424 --- /dev/null +++ b/src/apis/run/v1beta1.ts @@ -0,0 +1,1009 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace run_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Run API + * + * Deploy and manage user provided container images that scale automatically based on HTTP traffic. + * + * @example + * const {google} = require('googleapis'); + * const run = google.run('v1beta1'); + * + * @namespace run + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Run + */ + export class Run { + context: APIRequestContext; + customresourcedefinitions: Resource$Customresourcedefinitions; + namespaces: Resource$Namespaces; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.customresourcedefinitions = new Resource$Customresourcedefinitions( + this.context + ); + this.namespaces = new Resource$Namespaces(this.context); + this.projects = new Resource$Projects(this.context); + } + } + + /** + * CustomResourceColumnDefinition specifies a column for server side printing. + */ + export interface Schema$CustomResourceColumnDefinition { + /** + * description is a human readable description of this column. +optional + */ + description?: string | null; + /** + * format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more. +optional + */ + format?: string | null; + /** + * JSONPath is a simple JSON path, i.e. with array notation. + */ + jsonPath?: string | null; + /** + * name is a human readable name for the column. + */ + name?: string | null; + /** + * priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a higher priority. +optional + */ + priority?: number | null; + /** + * type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more. + */ + type?: string | null; + } + /** + * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. + */ + export interface Schema$CustomResourceDefinition { + /** + * The API version for this call such as "k8s.apiextensions.io/v1beta1". + */ + apiVersion?: string | null; + /** + * The kind of resource, one example is "Storage". + */ + kind?: string | null; + /** + * Metadata associated with this CustomResourceDefinition. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec describes how the user wants the resources to appear + */ + spec?: Schema$CustomResourceDefinitionSpec; + } + /** + * CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition + */ + export interface Schema$CustomResourceDefinitionNames { + /** + * Categories is a list of grouped resources custom resources belong to (e.g. 'all') +optional + */ + categories?: string[] | null; + /** + * Kind is the serialized kind of the resource. It is normally CamelCase and singular. + */ + kind?: string | null; + /** + * ListKind is the serialized kind of the list for this resource. Defaults to <kind>List. +optional + */ + listKind?: string | null; + /** + * Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase. + */ + plural?: string | null; + /** + * ShortNames are short names for the resource. It must be all lowercase. +optional + */ + shortNames?: string[] | null; + /** + * Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased <kind> +optional + */ + singular?: string | null; + } + /** + * CustomResourceDefinitionSpec describes how a user wants their resource to appear + */ + export interface Schema$CustomResourceDefinitionSpec { + /** + * AdditionalPrinterColumns are additional columns shown e.g. in kubectl next to the name. Defaults to a created-at column. +optional + */ + additionalPrinterColumns?: Schema$CustomResourceColumnDefinition[]; + /** + * Group is the group this resource belongs in + */ + group?: string | null; + /** + * Names are the names used to describe this custom resource + */ + names?: Schema$CustomResourceDefinitionNames; + /** + * Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced + */ + scope?: string | null; + /** + * Subresources describes the subresources for CustomResources +optional + */ + subresources?: Schema$CustomResourceSubresources; + /** + * Validation describes the validation methods for CustomResources +optional + */ + validation?: Schema$CustomResourceValidation; + /** + * Version is the version this resource belongs in Should be always first item in Versions field if provided. Optional, but at least one of Version or Versions must be set. Deprecated: Please use `Versions`. +optional + */ + version?: string | null; + /** + * Versions is the list of all supported versions for this resource. If Version field is provided, this field is optional. Validation: All versions must use the same validation schema for now. i.e., top level Validation field is applied to all of these versions. Order: The version name will be used to compute the order. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. +optional + */ + versions?: Schema$CustomResourceDefinitionVersion[]; + } + export interface Schema$CustomResourceDefinitionVersion { + /** + * Name is the version name, e.g. “v1”, “v2beta1”, etc. + */ + name?: string | null; + /** + * Served is a flag enabling/disabling this version from being served via REST APIs + */ + served?: boolean | null; + /** + * Storage flags the version as storage version. There must be exactly one flagged as storage version. + */ + storage?: boolean | null; + } + /** + * CustomResourceSubresources defines the status and scale subresources for CustomResources. + */ + export interface Schema$CustomResourceSubresources { + /** + * Scale denotes the scale subresource for CustomResources +optional + */ + scale?: Schema$CustomResourceSubresourceScale; + /** + * Status denotes the status subresource for CustomResources +optional + */ + status?: Schema$CustomResourceSubresourceStatus; + } + /** + * CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. + */ + export interface Schema$CustomResourceSubresourceScale { + /** + * LabelSelectorPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. Must be set to work with HPA. If there is no value under the given path in the CustomResource, the status label selector value in the /scale subresource will default to the empty string. +optional + */ + labelSelectorPath?: string | null; + /** + * SpecReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Spec.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .spec. If there is no value under the given path in the CustomResource, the /scale subresource will return an error on GET. + */ + specReplicasPath?: string | null; + /** + * StatusReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. If there is no value under the given path in the CustomResource, the status replica value in the /scale subresource will default to 0. + */ + statusReplicasPath?: string | null; + } + /** + * CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza + */ + export interface Schema$CustomResourceSubresourceStatus {} + /** + * CustomResourceValidation is a list of validation methods for CustomResources. + */ + export interface Schema$CustomResourceValidation { + /** + * OpenAPIV3Schema is the OpenAPI v3 schema to be validated against. +optional + */ + openAPIV3Schema?: Schema$JSONSchemaProps; + } + /** + * ExternalDocumentation allows referencing an external resource for extended documentation. + */ + export interface Schema$ExternalDocumentation { + description?: string | null; + url?: string | null; + } + /** + * JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil. + */ + export interface Schema$JSON { + raw?: string | null; + } + /** + * JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). + */ + export interface Schema$JSONSchemaProps { + additionalItems?: Schema$JSONSchemaPropsOrBool; + additionalProperties?: Schema$JSONSchemaPropsOrBool; + allOf?: Schema$JSONSchemaProps[]; + anyOf?: Schema$JSONSchemaProps[]; + default?: Schema$JSON; + definitions?: {[key: string]: Schema$JSONSchemaProps} | null; + dependencies?: {[key: string]: Schema$JSONSchemaPropsOrStringArray} | null; + description?: string | null; + enum?: string[] | null; + example?: Schema$JSON; + exclusiveMaximum?: boolean | null; + exclusiveMinimum?: boolean | null; + externalDocs?: Schema$ExternalDocumentation; + format?: string | null; + id?: string | null; + items?: Schema$JSONSchemaPropsOrArray; + maximum?: number | null; + maxItems?: string | null; + maxLength?: string | null; + maxProperties?: string | null; + minimum?: number | null; + minItems?: string | null; + minLength?: string | null; + minProperties?: string | null; + multipleOf?: number | null; + not?: Schema$JSONSchemaProps; + oneOf?: Schema$JSONSchemaProps[]; + pattern?: string | null; + patternProperties?: {[key: string]: Schema$JSONSchemaProps} | null; + properties?: {[key: string]: Schema$JSONSchemaProps} | null; + ref?: string | null; + required?: string[] | null; + schema?: string | null; + title?: string | null; + type?: string | null; + uniqueItems?: boolean | null; + } + /** + * JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes. + */ + export interface Schema$JSONSchemaPropsOrArray { + jsonSchemas?: Schema$JSONSchemaProps[]; + schema?: Schema$JSONSchemaProps; + } + /** + * JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property. + */ + export interface Schema$JSONSchemaPropsOrBool { + allows?: boolean | null; + schema?: Schema$JSONSchemaProps; + } + /** + * JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array. + */ + export interface Schema$JSONSchemaPropsOrStringArray { + property?: string[] | null; + schema?: Schema$JSONSchemaProps; + } + export interface Schema$ListCustomResourceDefinitionsResponse { + /** + * The API version for this call such as "k8s.apiextensions.io/v1beta1". + */ + apiVersion?: string | null; + /** + * List of CustomResourceDefinitions. + */ + items?: Schema$CustomResourceDefinition[]; + /** + * The kind of this resource, in this case "CustomResourceDefinitionList". + */ + kind?: string | null; + /** + * Metadata associated with this CustomResourceDefinition list. + */ + metadata?: Schema$ListMeta; + /** + * Locations that could not be reached. + */ + unreachable?: 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; + } + /** + * k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + */ + export interface Schema$ObjectMeta { + /** + * (Optional) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations + */ + annotations?: {[key: string]: string} | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. + */ + clusterName?: string | null; + /** + * (Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + */ + creationTimestamp?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. + */ + deletionGracePeriodSeconds?: number | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + */ + deletionTimestamp?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +patchStrategy=merge + */ + finalizers?: string[] | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2; + */ + generateName?: string | null; + /** + * (Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. + */ + generation?: number | null; + /** + * (Optional) 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 + */ + labels?: {[key: string]: string} | null; + /** + * Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional + */ + name?: string | null; + /** + * Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number. + */ + namespace?: string | null; + /** + * (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected. + */ + ownerReferences?: Schema$OwnerReference[]; + /** + * (Optional) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency + */ + resourceVersion?: string | null; + /** + * (Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4; + */ + selfLink?: string | null; + /** + * (Optional) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + */ + uid?: string | null; + } + /** + * OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field. + */ + export interface Schema$OwnerReference { + /** + * API version of the referent. + */ + apiVersion?: string | null; + /** + * If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional + */ + blockOwnerDeletion?: boolean | null; + /** + * If true, this reference points to the managing controller. +optional + */ + controller?: boolean | null; + /** + * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds + */ + kind?: string | null; + /** + * Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names + */ + name?: string | null; + /** + * UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + */ + uid?: string | null; + } + + export class Resource$Customresourcedefinitions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.customresourcedefinitions.list + * @desc Rpc to list custom resource definitions. + * @alias run.customresourcedefinitions.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 + * @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 {object} [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$Customresourcedefinitions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customresourcedefinitions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListCustomResourceDefinitionsResponse + > + ): void; + list( + params: Params$Resource$Customresourcedefinitions$List, + callback: BodyResponseCallback< + Schema$ListCustomResourceDefinitionsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$ListCustomResourceDefinitionsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Customresourcedefinitions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListCustomResourceDefinitionsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Customresourcedefinitions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customresourcedefinitions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions' + ).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$Customresourcedefinitions$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; + /** + * + */ + limit?: number; + /** + * The project ID or project number from which the storages 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 { + context: APIRequestContext; + customresourcedefinitions: Resource$Namespaces$Customresourcedefinitions; + constructor(context: APIRequestContext) { + this.context = context; + this.customresourcedefinitions = new Resource$Namespaces$Customresourcedefinitions( + this.context + ); + } + } + + export class Resource$Namespaces$Customresourcedefinitions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.customresourcedefinitions.get + * @desc Rpc to get information about a CustomResourceDefinition. + * @alias run.namespaces.customresourcedefinitions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the CustomResourceDefinition 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$Customresourcedefinitions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Customresourcedefinitions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Customresourcedefinitions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Namespaces$Customresourcedefinitions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Customresourcedefinitions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Customresourcedefinitions$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/apiextensions.k8s.io/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$Namespaces$Customresourcedefinitions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the CustomResourceDefinition being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + customresourcedefinitions: Resource$Projects$Locations$Customresourcedefinitions; + constructor(context: APIRequestContext) { + this.context = context; + this.customresourcedefinitions = new Resource$Projects$Locations$Customresourcedefinitions( + this.context + ); + } + } + + export class Resource$Projects$Locations$Customresourcedefinitions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.customresourcedefinitions.get + * @desc Rpc to get information about a CustomResourceDefinition. + * @alias run.projects.locations.customresourcedefinitions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the CustomResourceDefinition 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$Customresourcedefinitions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Customresourcedefinitions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customresourcedefinitions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customresourcedefinitions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customresourcedefinitions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customresourcedefinitions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').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.customresourcedefinitions.list + * @desc Rpc to list custom resource definitions. + * @alias run.projects.locations.customresourcedefinitions.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 + * @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 {object} [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$Customresourcedefinitions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Customresourcedefinitions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListCustomResourceDefinitionsResponse + > + ): void; + list( + params: Params$Resource$Projects$Locations$Customresourcedefinitions$List, + callback: BodyResponseCallback< + Schema$ListCustomResourceDefinitionsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$ListCustomResourceDefinitionsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customresourcedefinitions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListCustomResourceDefinitionsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customresourcedefinitions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customresourcedefinitions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/customresourcedefinitions' + ).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$Customresourcedefinitions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the CustomResourceDefinition being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Customresourcedefinitions$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; + /** + * + */ + limit?: number; + /** + * The project ID or project number from which the storages 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; + } +} diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index 44a0b20863a..5acdc5b257f 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -246,19 +246,19 @@ export namespace runtimeconfig_v1beta1 { response?: {[key: string]: any} | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -780,7 +780,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 runtimeconfig.projects.configs.setIamPolicy * @memberOf! () * diff --git a/src/apis/safebrowsing/v4.ts b/src/apis/safebrowsing/v4.ts index 12a0d263953..7ec399d8022 100644 --- a/src/apis/safebrowsing/v4.ts +++ b/src/apis/safebrowsing/v4.ts @@ -91,7 +91,7 @@ export namespace safebrowsing_v4 { /** * Safe Browsing API * - * Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. + * Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API. * * @example * const {google} = require('googleapis'); diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index dfe27e637c7..7f1bd5eb86d 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -130,7 +130,7 @@ export namespace securitycenter_v1 { */ iamPolicy?: Schema$IamPolicy; /** - * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/assets/456". + * 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; /** @@ -232,7 +232,7 @@ export namespace securitycenter_v1 { title?: 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. + * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. */ export interface Schema$Finding { /** @@ -252,11 +252,11 @@ export namespace securitycenter_v1 { */ externalUri?: string | null; /** - * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" + * 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/123/sources/456" + * 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; /** @@ -290,7 +290,7 @@ export namespace securitycenter_v1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; } @@ -329,11 +329,11 @@ export namespace securitycenter_v1 { */ 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: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. + * 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_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. */ filter?: string | null; /** - * 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_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type + * 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_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type */ groupBy?: string | null; /** @@ -379,11 +379,11 @@ export namespace securitycenter_v1 { */ compareDuration?: string | null; /** - * 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: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter 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 `<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. */ filter?: string | null; /** - * 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 + * 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 */ groupBy?: string | null; /** @@ -574,12 +574,12 @@ export namespace securitycenter_v1 { */ enableAssetDiscovery?: boolean | null; /** - * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". + * 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; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -587,15 +587,15 @@ export namespace securitycenter_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -637,7 +637,7 @@ export namespace securitycenter_v1 { */ 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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * 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; } @@ -646,11 +646,11 @@ export namespace securitycenter_v1 { */ export interface Schema$SetFindingStateRequest { /** - * The time at which the updated state takes effect. + * Required. The time at which the updated state takes effect. */ startTime?: string | null; /** - * The desired State of the finding. + * Required. The desired State of the finding. */ state?: string | null; } @@ -668,11 +668,11 @@ export namespace securitycenter_v1 { 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. + * 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, and other tools. */ 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." + * The description of the source (max of 1024 characters). Example: "Web 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 or insecure libraries." */ description?: string | null; /** @@ -680,7 +680,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" + * 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; } @@ -786,7 +786,7 @@ export namespace securitycenter_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". + * @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 @@ -916,7 +916,7 @@ export namespace securitycenter_v1 { * @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/123/organizationSettings". + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -996,7 +996,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". + * Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". */ name?: string; } @@ -1008,7 +1008,7 @@ export namespace securitycenter_v1 { 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/123/organizationSettings". + * 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; /** @@ -1099,7 +1099,7 @@ export namespace securitycenter_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the organization to groupBy. Its format is "organizations/[organization_id]". + * @param {string} params.parent Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]". * @param {().GroupAssetsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1241,7 +1241,7 @@ export namespace securitycenter_v1 { * @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_parent security_center_properties.resource_project security_center_properties.resource_type * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. * @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 Name of the organization assets should belong to. Its format is "organizations/[organization_id]". + * @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. @@ -1368,7 +1368,7 @@ export namespace securitycenter_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". + * @param {string} params.parent Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". * @param {().RunAssetDiscoveryRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1499,7 +1499,7 @@ export namespace securitycenter_v1 { * @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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * @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 {().SecurityMarks} params.resource Request body data @@ -1578,7 +1578,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to groupBy. Its format is "organizations/[organization_id]". + * Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]". */ parent?: string; @@ -1619,7 +1619,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Name of the organization assets should belong to. Its format is "organizations/[organization_id]". + * Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]". */ parent?: string; /** @@ -1635,7 +1635,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". + * Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". */ parent?: string; @@ -1652,7 +1652,7 @@ export namespace securitycenter_v1 { 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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * 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; /** @@ -2284,7 +2284,7 @@ export namespace securitycenter_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Resource name of the new source's parent. Its format should be "organizations/[organization_id]". + * @param {string} params.parent Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". * @param {().Source} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2405,7 +2405,7 @@ export namespace securitycenter_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". + * @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 @@ -2662,7 +2662,7 @@ export namespace securitycenter_v1 { * @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 Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". + * @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 @@ -2791,7 +2791,7 @@ export namespace securitycenter_v1 { * @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/123/sources/456" + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3124,7 +3124,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the new source's parent. Its format should be "organizations/[organization_id]". + * Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". */ parent?: string; @@ -3141,7 +3141,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". + * Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". */ name?: string; } @@ -3178,7 +3178,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". + * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". */ parent?: string; } @@ -3190,7 +3190,7 @@ export namespace securitycenter_v1 { 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/123/sources/456" + * 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; /** @@ -3302,8 +3302,8 @@ export namespace securitycenter_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.findingId 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 Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3372,7 +3372,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.group - * @desc Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/123/sources/-/findings + * @desc Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings * @example * * // BEFORE RUNNING: * // --------------- @@ -3443,7 +3443,7 @@ export namespace securitycenter_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/123/sources/- + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3516,7 +3516,7 @@ export namespace securitycenter_v1 { /** * securitycenter.organizations.sources.findings.list - * @desc Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/123/sources/-/findings + * @desc Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings * @example * * // BEFORE RUNNING: * // --------------- @@ -3589,7 +3589,7 @@ export namespace securitycenter_v1 { * @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 Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/123/sources/- + * @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. @@ -3721,7 +3721,7 @@ export namespace securitycenter_v1 { * @memberOf! () * * @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/123/sources/456/findings/789" + * @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 {().Finding} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3846,7 +3846,7 @@ export namespace securitycenter_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/finding/789". + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3975,7 +3975,7 @@ export namespace securitycenter_v1 { * @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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * @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 {().SecurityMarks} params.resource Request body data @@ -4054,11 +4054,11 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * 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. + * 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. */ findingId?: string; /** - * Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". + * Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". */ parent?: string; @@ -4075,7 +4075,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/123/sources/- + * 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/- */ parent?: string; @@ -4116,7 +4116,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/123/sources/- + * 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; /** @@ -4132,7 +4132,7 @@ export namespace securitycenter_v1 { 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/123/sources/456/findings/789" + * 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; /** @@ -4153,7 +4153,7 @@ export namespace securitycenter_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/finding/789". + * 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}". */ name?: string; @@ -4170,7 +4170,7 @@ export namespace securitycenter_v1 { 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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * 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; /** diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index 78da748bac3..8e829f50121 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -126,7 +126,7 @@ export namespace securitycenter_v1beta1 { */ createTime?: string | null; /** - * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/assets/456". + * 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; /** @@ -252,11 +252,11 @@ export namespace securitycenter_v1beta1 { */ externalUri?: string | null; /** - * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/findings/789" + * 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/123/sources/456" + * Immutable. 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; /** @@ -290,7 +290,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * 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; } @@ -333,7 +333,7 @@ export namespace securitycenter_v1beta1 { */ filter?: string | null; /** - * 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_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type + * 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_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type */ groupBy?: string | null; /** @@ -375,7 +375,7 @@ export namespace securitycenter_v1beta1 { */ filter?: string | null; /** - * Expression that defines what assets fields to use for grouping (including `state`). 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 + * Required. Expression that defines what assets fields to use for grouping (including `state`). 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 */ groupBy?: string | null; /** @@ -540,12 +540,12 @@ export namespace securitycenter_v1beta1 { */ enableAssetDiscovery?: boolean | null; /** - * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/organizationSettings". + * 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; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -553,15 +553,15 @@ export namespace securitycenter_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Deprecated. + * 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. */ version?: number | null; } @@ -574,7 +574,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$SecurityCenterProperties { /** - * 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 + * Immutable. 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; /** @@ -603,7 +603,7 @@ export namespace securitycenter_v1beta1 { */ 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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * 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; } @@ -612,11 +612,11 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$SetFindingStateRequest { /** - * The time at which the updated state takes effect. + * Required. The time at which the updated state takes effect. */ startTime?: string | null; /** - * The desired State of the finding. + * Required. The desired State of the finding. */ state?: string | null; } @@ -646,7 +646,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456" + * 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; } @@ -705,7 +705,7 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". + * @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 @@ -781,7 +781,7 @@ export namespace securitycenter_v1beta1 { * @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/123/organizationSettings". + * @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. * @param {().OrganizationSettings} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -861,7 +861,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". + * Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". */ name?: string; } @@ -873,7 +873,7 @@ export namespace securitycenter_v1beta1 { 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/123/organizationSettings". + * 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; /** @@ -900,7 +900,7 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the organization to groupBy. Its format is "organizations/[organization_id]". + * @param {string} params.parent Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]". * @param {().GroupAssetsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -982,7 +982,7 @@ export namespace securitycenter_v1beta1 { * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. * @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 Name of the organization assets should belong to. Its format is "organizations/[organization_id]". + * @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. @@ -1058,7 +1058,7 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". + * @param {string} params.parent Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". * @param {().RunAssetDiscoveryRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1134,7 +1134,7 @@ export namespace securitycenter_v1beta1 { * @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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * @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.resource Request body data @@ -1213,7 +1213,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to groupBy. Its format is "organizations/[organization_id]". + * Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]". */ parent?: string; @@ -1254,7 +1254,7 @@ export namespace securitycenter_v1beta1 { */ pageToken?: string; /** - * Name of the organization assets should belong to. Its format is "organizations/[organization_id]". + * Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]". */ parent?: string; /** @@ -1270,7 +1270,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". + * Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". */ parent?: string; @@ -1287,7 +1287,7 @@ export namespace securitycenter_v1beta1 { 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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * 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; /** @@ -1686,7 +1686,7 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Resource name of the new source's parent. Its format should be "organizations/[organization_id]". + * @param {string} params.parent Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". * @param {().Source} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1760,7 +1760,7 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". + * @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 @@ -1906,7 +1906,7 @@ export namespace securitycenter_v1beta1 { * @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 Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". + * @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 @@ -1981,7 +1981,7 @@ export namespace securitycenter_v1beta1 { * @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/123/sources/456" + * @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. * @param {().Source} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2212,7 +2212,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the new source's parent. Its format should be "organizations/[organization_id]". + * Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". */ parent?: string; @@ -2229,7 +2229,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". + * Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". */ name?: string; } @@ -2266,7 +2266,7 @@ export namespace securitycenter_v1beta1 { */ pageToken?: string; /** - * Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". + * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". */ parent?: string; } @@ -2278,7 +2278,7 @@ export namespace securitycenter_v1beta1 { 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/123/sources/456" + * 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; /** @@ -2339,8 +2339,8 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.findingId 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 Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2409,12 +2409,12 @@ export namespace securitycenter_v1beta1 { /** * 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: /v1beta1/organizations/123/sources/-/findings + * @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: /v1beta1/organizations/{organization_id}/sources/-/findings * @alias securitycenter.organizations.sources.findings.group * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/123/sources/- + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2487,7 +2487,7 @@ export namespace securitycenter_v1beta1 { /** * 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: /v1beta1/organizations/123/sources/-/findings + * @desc Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings * @alias securitycenter.organizations.sources.findings.list * @memberOf! () * @@ -2497,7 +2497,7 @@ export namespace securitycenter_v1beta1 { * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. * @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 Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/123/sources/- + * @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. @@ -2575,7 +2575,7 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @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/123/sources/456/findings/789" + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2647,7 +2647,7 @@ export namespace securitycenter_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/finding/789". + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2721,7 +2721,7 @@ export namespace securitycenter_v1beta1 { * @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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * @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.resource Request body data @@ -2800,11 +2800,11 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * 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. + * 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. */ findingId?: string; /** - * Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". + * Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". */ parent?: string; @@ -2821,7 +2821,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/123/sources/- + * 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/- */ parent?: string; @@ -2858,7 +2858,7 @@ export namespace securitycenter_v1beta1 { */ pageToken?: string; /** - * Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/123/sources/- + * 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; /** @@ -2874,7 +2874,7 @@ export namespace securitycenter_v1beta1 { 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/123/sources/456/findings/789" + * 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; /** @@ -2895,7 +2895,7 @@ export namespace securitycenter_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/123/sources/456/finding/789". + * 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}". */ name?: string; @@ -2912,7 +2912,7 @@ export namespace securitycenter_v1beta1 { 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/123/assets/456/securityMarks" "organizations/123/sources/456/findings/789/securityMarks". + * 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; /** diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts index 87c442bc347..693ec032bab 100644 --- a/src/apis/servicebroker/v1.ts +++ b/src/apis/servicebroker/v1.ts @@ -135,19 +135,19 @@ export namespace servicebroker_v1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -285,7 +285,7 @@ export namespace servicebroker_v1 { /** * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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! () * diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index df661f78a16..21a3d979cdf 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -484,19 +484,19 @@ export namespace servicebroker_v1alpha1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -2377,7 +2377,7 @@ export namespace servicebroker_v1alpha1 { /** * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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! () * diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index f8b1ea30136..3cdf0edbe2c 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -542,19 +542,19 @@ export namespace servicebroker_v1beta1 { role?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$GoogleIamV1__Policy { /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ bindings?: Schema$GoogleIamV1__Binding[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -2930,7 +2930,7 @@ export namespace servicebroker_v1beta1 { /** * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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! () * diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index ff679c71d3a..09a55ba2a78 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -812,6 +812,10 @@ export namespace serviceconsumermanagement_v1 { * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string | null; + /** + * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. + */ + monitoredResourceTypes?: string[] | null; /** * The resource name of the metric descriptor. */ @@ -838,7 +842,7 @@ export namespace serviceconsumermanagement_v1 { */ ingestDelay?: string | null; /** - * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. + * Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: string | null; /** @@ -1462,6 +1466,15 @@ export namespace serviceconsumermanagement_v1 { * Response message for the `EnableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1Beta1EnableConsumerResponse {} + /** + * Response message for the `GenerateServiceIdentity` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. + */ + export interface Schema$V1Beta1GenerateServiceIdentityResponse { + /** + * ServiceIdentity that was created or retrieved. + */ + identity?: Schema$V1Beta1ServiceIdentity; + } /** * Response message for ImportProducerOverrides */ @@ -1500,6 +1513,27 @@ export namespace serviceconsumermanagement_v1 { * Response message for the `RefreshConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ export interface Schema$V1Beta1RefreshConsumerResponse {} + /** + * A service identity in the Identity and Access Management API. + */ + export interface Schema$V1Beta1ServiceIdentity { + /** + * The email address of the service identity. + */ + email?: string | null; + /** + * P4 service identity resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` + */ + name?: string | null; + /** + * The P4 service identity configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to "default". + */ + tag?: string | null; + /** + * The unique and stable id of the service identity. + */ + uniqueId?: string | null; + } /** * Response message for the `DisableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 240642d373b..e2fc3da1696 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -779,10 +779,6 @@ export namespace servicecontrol_v1 { * Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed. */ quotaProperties?: Schema$QuotaProperties; - /** - * DO NOT USE. This field is deprecated, use "resources" field instead. The resource name of the parent of a resource in the resource hierarchy. This can be in one of the following formats: - “projects/<project-id or project-number>” - “folders/<folder-id>” - “organizations/<organization-id>” - */ - resourceContainer?: string | null; /** * The resources that are involved in the operation. The maximum supported number of entries in this field is 100. */ @@ -872,7 +868,7 @@ export namespace servicecontrol_v1 { */ methodName?: string | null; /** - * Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details. + * Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries. In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID */ operationId?: string | null; /** diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 5d1d2adedb3..520943dbcfd 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -518,10 +518,14 @@ export namespace servicemanagement_v1 { */ export interface Schema$DisableServiceRequest { /** - * The identity of consumer resource which service disablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. + * Required. The identity of consumer resource which service disablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. */ consumerId?: string | null; } + /** + * Operation payload for DisableService method. + */ + export interface Schema$DisableServiceResponse {} /** * `Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: &#40;== include google/foo/overview.md ==&#41; - name: Tutorial content: &#40;== include google/foo/tutorial.md ==&#41; subpages; - name: Java content: &#40;== include google/foo/tutorial_java.md ==&#41; rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> To override the display text used for the link, this can be used: <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>&#40;-- internal comment --&#41;</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>&#40;== include path/to/file ==&#41;</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ @@ -573,10 +577,14 @@ export namespace servicemanagement_v1 { */ export interface Schema$EnableServiceRequest { /** - * The identity of consumer resource which service enablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. + * Required. The identity of consumer resource which service enablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. */ consumerId?: string | null; } + /** + * Operation payload for EnableService method. + */ + export interface Schema$EnableServiceResponse {} /** * `Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true */ @@ -728,11 +736,11 @@ export namespace servicemanagement_v1 { */ export interface Schema$GenerateConfigReportRequest { /** - * Service configuration for which we want to generate the report. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service + * Required. Service configuration for which we want to generate the report. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service */ newConfig?: {[key: string]: any} | null; /** - * Service configuration against which the comparison will be done. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service + * Optional. Service configuration against which the comparison will be done. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service */ oldConfig?: {[key: string]: any} | null; } @@ -1023,6 +1031,10 @@ export namespace servicemanagement_v1 { * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string | null; + /** + * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. + */ + monitoredResourceTypes?: string[] | null; /** * The resource name of the metric descriptor. */ @@ -1049,7 +1061,7 @@ export namespace servicemanagement_v1 { */ ingestDelay?: string | null; /** - * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. + * Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: string | null; /** @@ -1224,7 +1236,7 @@ export namespace servicemanagement_v1 { subpages?: Schema$Page[]; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * 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). */ export interface Schema$Policy { /** @@ -1232,15 +1244,15 @@ export namespace servicemanagement_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. + * 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. */ 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. + * `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?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * 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. */ version?: number | null; } @@ -1274,7 +1286,7 @@ export namespace servicemanagement_v1 { */ displayName?: string | null; /** - * Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. + * Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */ duration?: string | null; /** @@ -1319,7 +1331,7 @@ export namespace servicemanagement_v1 { */ deleteServiceStrategy?: Schema$DeleteServiceStrategy; /** - * Optional unique identifier of this Rollout. Only lower case letters, digits and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of <date><revision number>, where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1' + * Optional. Unique identifier of this Rollout. Only lower case letters, digits and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of <date><revision number>, where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1' */ rolloutId?: string | null; /** @@ -1514,7 +1526,7 @@ export namespace servicemanagement_v1 { */ export interface Schema$SubmitConfigSourceRequest { /** - * The source configuration for the service. + * Required. The source configuration for the service. */ configSource?: Schema$ConfigSource; /** @@ -1589,7 +1601,7 @@ export namespace servicemanagement_v1 { permissions?: string[] | null; } /** - * Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured precentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } } + * Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } } */ export interface Schema$TrafficPercentStrategy { /** @@ -1949,7 +1961,7 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2023,7 +2035,7 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.serviceName Name of the service to disable. Specifying an unknown service name will cause the request to fail. + * @param {string} params.serviceName Required. Name of the service to disable. Specifying an unknown service name will cause the request to fail. * @param {().DisableServiceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2098,7 +2110,7 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.serviceName Name of the service to enable. Specifying an unknown service name will cause the request to fail. + * @param {string} params.serviceName Required. Name of the service to enable. Specifying an unknown service name will cause the request to fail. * @param {().EnableServiceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2257,7 +2269,7 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.serviceName The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.serviceName Required. The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2331,8 +2343,8 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.configId The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string=} params.configId Required. The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {string=} params.view Specifies which parts of the Service Config should be returned in the response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2551,7 +2563,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 servicemanagement.services.setIamPolicy * @memberOf! () * @@ -2713,7 +2725,7 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2800,7 +2812,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -2811,7 +2823,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the service to disable. Specifying an unknown service name will cause the request to fail. + * Required. Name of the service to disable. Specifying an unknown service name will cause the request to fail. */ serviceName?: string; @@ -2827,7 +2839,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the service to enable. Specifying an unknown service name will cause the request to fail. + * Required. Name of the service to enable. Specifying an unknown service name will cause the request to fail. */ serviceName?: string; @@ -2855,7 +2867,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -2867,11 +2879,11 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. + * Required. The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. */ configId?: string; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; /** @@ -2961,7 +2973,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -2979,7 +2991,7 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {().Service} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3053,8 +3065,8 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.configId The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.configId Required. The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {string=} params.view Specifies which parts of the Service Config should be returned in the response. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3129,7 +3141,7 @@ export namespace servicemanagement_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100. * @param {string=} params.pageToken The token of the page to retrieve. - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3211,7 +3223,7 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {().SubmitConfigSourceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3288,7 +3300,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; @@ -3305,11 +3317,11 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. + * Required. The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. */ configId?: string; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; /** @@ -3333,7 +3345,7 @@ export namespace servicemanagement_v1 { */ pageToken?: string; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -3345,7 +3357,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; @@ -3437,7 +3449,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.consumers.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. + * @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 servicemanagement.services.consumers.setIamPolicy * @memberOf! () * @@ -3659,7 +3671,7 @@ export namespace servicemanagement_v1 { * * @param {object} params Parameters for request * @param {string=} params.baseRolloutId Unimplemented. Do not use this feature until this comment is removed. The rollout id that rollout to be created based on. Rollout should be constructed based on current successful rollout, this field indicates the current successful rollout id that new rollout based on to construct, if current successful rollout changed when server receives the request, request will be rejected for safety. - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {().Rollout} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3735,8 +3747,8 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.rolloutId The id of the rollout resource. - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.rolloutId Required. The id of the rollout resource. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3808,10 +3820,10 @@ export namespace servicemanagement_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED' + * @param {string=} params.filter Required. Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED' * @param {integer=} params.pageSize The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100. * @param {string=} params.pageToken The token of the page to retrieve. - * @param {string} params.serviceName The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * @param {string} params.serviceName Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3899,7 +3911,7 @@ export namespace servicemanagement_v1 { */ baseRolloutId?: string; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; @@ -3916,11 +3928,11 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The id of the rollout resource. + * Required. The id of the rollout resource. */ rolloutId?: string; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } @@ -3932,7 +3944,7 @@ export namespace servicemanagement_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED' + * Required. Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED' */ filter?: string; /** @@ -3944,7 +3956,7 @@ export namespace servicemanagement_v1 { */ pageToken?: string; /** - * The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. + * Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */ serviceName?: string; } diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index d39c1cd939a..4021fa52db5 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -817,6 +817,10 @@ export namespace servicenetworking_v1 { * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string | null; + /** + * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. + */ + monitoredResourceTypes?: string[] | null; /** * The resource name of the metric descriptor. */ @@ -843,7 +847,7 @@ export namespace servicenetworking_v1 { */ ingestDelay?: string | null; /** - * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. + * Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: string | null; /** diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 5898dffb5d5..64a77a721d6 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -796,6 +796,10 @@ export namespace servicenetworking_v1beta { * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string | null; + /** + * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. + */ + monitoredResourceTypes?: string[] | null; /** * The resource name of the metric descriptor. */ @@ -822,7 +826,7 @@ export namespace servicenetworking_v1beta { */ ingestDelay?: string | null; /** - * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. + * Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: string | null; /** diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index ab035e023f9..7be5ddcbc1c 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -743,6 +743,32 @@ export namespace serviceusage_v1 { */ usage?: Schema$Usage; } + /** + * Response message for getting service identity. + */ + export interface Schema$GoogleApiServiceusageV1beta1GetServiceIdentityResponse { + /** + * Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id. + */ + identity?: Schema$GoogleApiServiceusageV1beta1ServiceIdentity; + /** + * Service identity state. + */ + state?: string | null; + } + /** + * Service identity for a service. This is the identity that service producer should use to access consumer resources. + */ + export interface Schema$GoogleApiServiceusageV1beta1ServiceIdentity { + /** + * The email address of the service account that a service producer would use to access consumer resources. + */ + email?: string | null; + /** + * The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + */ + uniqueId?: string | null; + } /** * The operation metadata returned for the batchend services operation. */ @@ -1019,6 +1045,10 @@ export namespace serviceusage_v1 { * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string | null; + /** + * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. + */ + monitoredResourceTypes?: string[] | null; /** * The resource name of the metric descriptor. */ @@ -1045,7 +1075,7 @@ export namespace serviceusage_v1 { */ ingestDelay?: string | null; /** - * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. + * Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: string | null; /** diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index b743e1e47ff..ba40ab3b9ab 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -734,6 +734,32 @@ export namespace serviceusage_v1beta1 { */ usage?: Schema$Usage; } + /** + * Response message for getting service identity. + */ + export interface Schema$GoogleApiServiceusageV1beta1GetServiceIdentityResponse { + /** + * Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id. + */ + identity?: Schema$GoogleApiServiceusageV1beta1ServiceIdentity; + /** + * Service identity state. + */ + state?: string | null; + } + /** + * Service identity for a service. This is the identity that service producer should use to access consumer resources. + */ + export interface Schema$GoogleApiServiceusageV1beta1ServiceIdentity { + /** + * The email address of the service account that a service producer would use to access consumer resources. + */ + email?: string | null; + /** + * The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + */ + uniqueId?: string | null; + } /** * The operation metadata returned for the batchend services operation. */ @@ -1010,6 +1036,10 @@ export namespace serviceusage_v1beta1 { * Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: string | null; + /** + * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. + */ + monitoredResourceTypes?: string[] | null; /** * The resource name of the metric descriptor. */ @@ -1036,7 +1066,7 @@ export namespace serviceusage_v1beta1 { */ ingestDelay?: string | null; /** - * Deprecated. Please use the MetricDescriptor.launch_stage instead. The launch stage of the metric definition. + * Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: string | null; /** diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 61d5dfe13ec..6eddf00ff9c 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -256,6 +256,24 @@ export namespace sheets_v4 { */ properties?: Schema$SheetProperties; } + /** + * Adds a slicer to a sheet in the spreadsheet. + */ + export interface Schema$AddSlicerRequest { + /** + * The slicer that should be added to the spreadsheet, including the position where it should be placed. The slicerId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a slicer that already exists.) + */ + slicer?: Schema$Slicer; + } + /** + * The result of adding a slicer to a spreadsheet. + */ + export interface Schema$AddSlicerResponse { + /** + * The newly added slicer. + */ + slicer?: Schema$Slicer; + } /** * Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary. */ @@ -375,6 +393,35 @@ export namespace sheets_v4 { */ secondBandColor?: Schema$Color; } + /** + * Formatting options for baseline value. + */ + export interface Schema$BaselineValueFormat { + /** + * The comparison type of key value with baseline value. + */ + comparisonType?: string | null; + /** + * Description which is appended after the baseline value. This field is optional. + */ + description?: string | null; + /** + * Color to be used, in case baseline value represents a negative change for key value. This field is optional. + */ + negativeColor?: Schema$Color; + /** + * Specifies the horizontal text positioning of baseline value. This field is optional. If not specified, default positioning is used. + */ + position?: Schema$TextPosition; + /** + * Color to be used, in case baseline value represents a positive change for key value. This field is optional. + */ + positiveColor?: Schema$Color; + /** + * Text formatting options for baseline value. + */ + textFormat?: Schema$TextFormat; + } /** * An axis of the chart. A chart may not have more than one axis per axis position. */ @@ -1021,6 +1068,19 @@ export namespace sheets_v4 { */ viewWindowMode?: string | null; } + /** + * Custom number formatting options for chart attributes. + */ + export interface Schema$ChartCustomNumberFormatOptions { + /** + * Custom prefix to be prepended to the chart attribute. This field is optional. + */ + prefix?: string | null; + /** + * Custom suffix to be appended to the chart attribute. This field is optional. + */ + suffix?: string | null; + } /** * The data included in a domain or series. */ @@ -1087,6 +1147,10 @@ export namespace sheets_v4 { * A pie chart specification. */ pieChart?: Schema$PieChartSpec; + /** + * A scorecard chart specification. + */ + scorecardChart?: Schema$ScorecardChartSpec; /** * The subtitle of the chart. */ @@ -1769,6 +1833,14 @@ export namespace sheets_v4 { * Values that should be hidden. */ 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. + */ + 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. + */ + visibleForegroundColor?: Schema$Color; } /** * A filter view. @@ -2106,6 +2178,19 @@ export namespace sheets_v4 { */ maxIterations?: number | null; } + /** + * Formatting options for key value. + */ + export interface Schema$KeyValueFormat { + /** + * Specifies the horizontal text positioning of key value. This field is optional. If not specified, default positioning is used. + */ + position?: Schema$TextPosition; + /** + * Text formatting options for key value. + */ + textFormat?: Schema$TextFormat; + } /** * Properties that describe the style of a line. */ @@ -2590,6 +2675,10 @@ export namespace sheets_v4 { * Adds a sheet. */ addSheet?: Schema$AddSheetRequest; + /** + * Adds a slicer. + */ + addSlicer?: Schema$AddSlicerRequest; /** * Appends cells after the last row with data in a sheet. */ @@ -2786,6 +2875,10 @@ export namespace sheets_v4 { * Updates a sheet's properties. */ updateSheetProperties?: Schema$UpdateSheetPropertiesRequest; + /** + * Updates a slicer's specifications. + */ + updateSlicerSpec?: Schema$UpdateSlicerSpecRequest; /** * Updates the spreadsheet's properties. */ @@ -2823,6 +2916,10 @@ export namespace sheets_v4 { * A reply from adding a sheet. */ addSheet?: Schema$AddSheetResponse; + /** + * A reply from adding a slicer. + */ + addSlicer?: Schema$AddSlicerResponse; /** * A reply from creating a developer metadata entry. */ @@ -2881,6 +2978,43 @@ export namespace sheets_v4 { */ values?: Schema$CellData[]; } + /** + * A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time. + */ + export interface Schema$ScorecardChartSpec { + /** + * The aggregation type for key and baseline chart data in scorecard chart. This field is optional. + */ + aggregateType?: string | null; + /** + * The data for scorecard baseline value. This field is optional. + */ + baselineValueData?: Schema$ChartData; + /** + * Formatting options for baseline value. This field is needed only if baseline_value_data is specified. + */ + baselineValueFormat?: Schema$BaselineValueFormat; + /** + * Custom formatting options for numeric key/baseline values in scorecard chart. This field is used only when number_format_source is set to CUSTOM. This field is optional. + */ + customFormatOptions?: Schema$ChartCustomNumberFormatOptions; + /** + * The data for scorecard key value. + */ + keyValueData?: Schema$ChartData; + /** + * Formatting options for key value. + */ + keyValueFormat?: Schema$KeyValueFormat; + /** + * The number format source used in the scorecard chart. This field is optional. + */ + numberFormatSource?: string | null; + /** + * Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional. + */ + scaleFactor?: number | null; + } /** * A request to retrieve all developer metadata matching the set of specified criteria. */ @@ -2973,6 +3107,10 @@ export namespace sheets_v4 { * All row groups on this sheet, ordered by increasing range start index, then by group depth. */ rowGroups?: Schema$DimensionGroup[]; + /** + * The slicers on this sheet. + */ + slicers?: Schema$Slicer[]; } /** * Properties of a sheet. @@ -3011,6 +3149,60 @@ export namespace sheets_v4 { */ title?: string | null; } + /** + * A slicer in a sheet. + */ + export interface Schema$Slicer { + /** + * The position of the slicer. Note that slicer can be positioned only on existing sheet. Also, width and height of slicer can be automatically adjusted to keep it within permitted limits. + */ + position?: Schema$EmbeddedObjectPosition; + /** + * The ID of the slicer. + */ + slicerId?: number | null; + /** + * The specification of the slicer. + */ + spec?: Schema$SlicerSpec; + } + /** + * The specifications of a slicer. + */ + export interface Schema$SlicerSpec { + /** + * True if the filter should apply to pivot tables. If not set, default to `True`. + */ + applyToPivotTables?: boolean | null; + /** + * The background color of the slicer. + */ + backgroundColor?: Schema$Color; + /** + * The column index in the data table on which the filter is applied to. + */ + columnIndex?: number | null; + /** + * The data range of the slicer. + */ + dataRange?: Schema$GridRange; + /** + * The filtering criteria of the slicer. + */ + filterCriteria?: Schema$FilterCriteria; + /** + * The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT` + */ + horizontalAlignment?: string | null; + /** + * The text format of title in the slicer. + */ + textFormat?: Schema$TextFormat; + /** + * The title of the slicer. + */ + title?: string | null; + } /** * Sorts data in rows based on a sort order per column. */ @@ -3028,10 +3220,18 @@ export namespace sheets_v4 { * A sort order associated with a specific column or row. */ 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. + */ + backgroundColor?: Schema$Color; /** * 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. + */ + foregroundColor?: Schema$Color; /** * The order data should be sorted. */ @@ -3554,6 +3754,23 @@ export namespace sheets_v4 { */ properties?: Schema$SheetProperties; } + /** + * Updates a slicer’s specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest. + */ + export interface Schema$UpdateSlicerSpecRequest { + /** + * The fields that should be updated. At least one field must be specified. The root `SlicerSpec` is implied and should not be specified. A single "*"` can be used as short-hand for listing every field. + */ + fields?: string | null; + /** + * The id of the slicer to update. + */ + slicerId?: number | null; + /** + * The specification to apply to the slicer. + */ + spec?: Schema$SlicerSpec; + } /** * Updates properties of a spreadsheet. */ diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 07cc4a19a78..7c509af1702 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -122,7 +122,7 @@ export namespace spanner_v1 { */ export interface Schema$BatchCreateSessionsRequest { /** - * Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary). The maximum allowed sessions are documented at https://goo.gl/hBUQED. + * Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary). */ sessionCount?: number | null; /** @@ -427,7 +427,7 @@ export namespace spanner_v1 { */ export interface Schema$GetPolicyOptions { /** - * Optional. The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned. + * Optional. The policy format version to be returned. Acceptable values are 0, 1, and 3. If the value is 0, or the field is omitted, policy format version 1 will be returned. */ requestedPolicyVersion?: number | null; } @@ -597,7 +597,7 @@ export namespace spanner_v1 { */ insertOrUpdate?: Schema$Write; /** - * Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. + * Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. In an interleaved table, if you create the child table with the `ON DELETE CASCADE` annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row. */ replace?: Schema$Write; /** @@ -3335,7 +3335,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.batchCreate - * @desc Creates multiple new sessions. If the requested number of sessions would cause the database to exceed its session limit, returns a RESOURCE_EXHAUSTED error. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. + * @desc Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. * @alias spanner.projects.instances.databases.sessions.batchCreate * @memberOf! () * diff --git a/src/apis/speech/index.ts b/src/apis/speech/index.ts index 143418d67dd..83c35dd8bca 100644 --- a/src/apis/speech/index.ts +++ b/src/apis/speech/index.ts @@ -16,12 +16,12 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {speech_v1} from './v1'; import {speech_v1p1beta1} from './v1p1beta1'; -import {speech_v2beta} from './v2beta'; +import {speech_v2beta1} from './v2beta1'; export const VERSIONS = { v1: speech_v1.Speech, v1p1beta1: speech_v1p1beta1.Speech, - v2beta: speech_v2beta.Speech, + v2beta1: speech_v2beta1.Speech, }; export function speech(version: 'v1'): speech_v1.Speech; @@ -30,10 +30,10 @@ export function speech(version: 'v1p1beta1'): speech_v1p1beta1.Speech; export function speech( options: speech_v1p1beta1.Options ): speech_v1p1beta1.Speech; -export function speech(version: 'v2beta'): speech_v2beta.Speech; -export function speech(options: speech_v2beta.Options): speech_v2beta.Speech; +export function speech(version: 'v2beta1'): speech_v2beta1.Speech; +export function speech(options: speech_v2beta1.Options): speech_v2beta1.Speech; export function speech< - T = speech_v1.Speech | speech_v1p1beta1.Speech | speech_v2beta.Speech + T = speech_v1.Speech | speech_v1p1beta1.Speech | speech_v2beta1.Speech >( this: GoogleConfigurable, versionOrOptions: @@ -41,8 +41,8 @@ export function speech< | speech_v1.Options | 'v1p1beta1' | speech_v1p1beta1.Options - | 'v2beta' - | speech_v2beta.Options + | 'v2beta1' + | speech_v2beta1.Options ) { return getAPI('speech', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index 221697688d0..600e2367751 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -156,11 +156,11 @@ export namespace speech_v1 { */ export interface Schema$LongRunningRecognizeRequest { /** - * *Required* The audio data to be recognized. + * Required. The audio data to be recognized. */ audio?: Schema$RecognitionAudio; /** - * *Required* Provides information to the recognizer that specifies how to process the request. + * Required. Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; } @@ -169,7 +169,7 @@ export namespace speech_v1 { */ export interface Schema$LongRunningRecognizeResponse { /** - * Output only. Sequential list of transcription results corresponding to sequential portions of audio. + * Sequential list of transcription results corresponding to sequential portions of audio. */ results?: Schema$SpeechRecognitionResult[]; } @@ -216,11 +216,15 @@ export namespace speech_v1 { */ export interface Schema$RecognitionConfig { /** - * *Optional* The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set `enable_separate_recognition_per_channel` to 'true'. + * The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set `enable_separate_recognition_per_channel` to 'true'. */ audioChannelCount?: number | null; /** - * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. + * Config to enable speaker diarization and set additional parameters to make diarization better suited for your application. Note: When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult. + */ + diarizationConfig?: Schema$SpeakerDiarizationConfig; + /** + * If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. */ enableAutomaticPunctuation?: boolean | null; /** @@ -228,7 +232,7 @@ export namespace speech_v1 { */ enableSeparateRecognitionPerChannel?: boolean | null; /** - * *Optional* If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. + * If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. */ enableWordTimeOffsets?: boolean | null; /** @@ -236,23 +240,23 @@ export namespace speech_v1 { */ encoding?: string | null; /** - * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. + * Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. */ languageCode?: string | null; /** - * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. + * Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number | null; /** - * *Optional* Metadata regarding this request. + * Metadata regarding this request. */ metadata?: Schema$RecognitionMetadata; /** - * *Optional* Which 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 RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table> + * Which 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 RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table> */ model?: string | null; /** - * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. + * If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ profanityFilter?: boolean | null; /** @@ -260,11 +264,11 @@ export namespace speech_v1 { */ sampleRateHertz?: number | null; /** - * *Optional* array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/context-strength). + * Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/context-strength). */ speechContexts?: Schema$SpeechContext[]; /** - * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. + * Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. */ useEnhanced?: boolean | null; } @@ -314,11 +318,11 @@ export namespace speech_v1 { */ export interface Schema$RecognizeRequest { /** - * *Required* The audio data to be recognized. + * Required. The audio data to be recognized. */ audio?: Schema$RecognitionAudio; /** - * *Required* Provides information to the recognizer that specifies how to process the request. + * Required. Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; } @@ -327,16 +331,33 @@ export namespace speech_v1 { */ export interface Schema$RecognizeResponse { /** - * Output only. Sequential list of transcription results corresponding to sequential portions of audio. + * Sequential list of transcription results corresponding to sequential portions of audio. */ results?: Schema$SpeechRecognitionResult[]; } + /** + * Config to enable speaker diarization. + */ + export interface Schema$SpeakerDiarizationConfig { + /** + * If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. + */ + enableSpeakerDiarization?: boolean | null; + /** + * Maximum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 6. + */ + maxSpeakerCount?: number | null; + /** + * Minimum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 2. + */ + minSpeakerCount?: number | null; + } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ export interface Schema$SpeechContext { /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months. + * A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months. */ phrases?: string[] | null; } @@ -345,15 +366,15 @@ export namespace speech_v1 { */ export interface Schema$SpeechRecognitionAlternative { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number | null; /** - * Output only. Transcript text representing the words that the user spoke. + * Transcript text representing the words that the user spoke. */ transcript?: string | null; /** - * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. + * A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$WordInfo[]; } @@ -362,7 +383,7 @@ export namespace speech_v1 { */ export interface Schema$SpeechRecognitionResult { /** - * Output only. May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$SpeechRecognitionAlternative[]; /** @@ -392,15 +413,19 @@ export namespace speech_v1 { */ export interface Schema$WordInfo { /** - * Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string | null; /** - * Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. + * A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. + */ + speakerTag?: number | null; + /** + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string | null; /** - * Output only. The word corresponding to this set of information. + * The word corresponding to this set of information. */ word?: string | null; } diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts index 370bdb94642..0429e278b0c 100644 --- a/src/apis/speech/v1p1beta1.ts +++ b/src/apis/speech/v1p1beta1.ts @@ -156,11 +156,11 @@ export namespace speech_v1p1beta1 { */ export interface Schema$LongRunningRecognizeRequest { /** - * *Required* The audio data to be recognized. + * Required. The audio data to be recognized. */ audio?: Schema$RecognitionAudio; /** - * *Required* Provides information to the recognizer that specifies how to process the request. + * Required. Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; } @@ -169,7 +169,7 @@ export namespace speech_v1p1beta1 { */ export interface Schema$LongRunningRecognizeResponse { /** - * Output only. Sequential list of transcription results corresponding to sequential portions of audio. + * Sequential list of transcription results corresponding to sequential portions of audio. */ results?: Schema$SpeechRecognitionResult[]; } @@ -216,23 +216,23 @@ export namespace speech_v1p1beta1 { */ export interface Schema$RecognitionConfig { /** - * *Optional* A list of up to 3 additional [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, listing possible alternative languages of the supplied audio. See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. If alternative languages are listed, recognition result will contain recognition in the most likely language detected including the main language_code. The recognition result will include the language tag of the language detected in the audio. Note: This feature is only supported for Voice Command and Voice Search use cases and performance may vary for other use cases (e.g., phone call transcription). + * A list of up to 3 additional [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, listing possible alternative languages of the supplied audio. See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. If alternative languages are listed, recognition result will contain recognition in the most likely language detected including the main language_code. The recognition result will include the language tag of the language detected in the audio. Note: This feature is only supported for Voice Command and Voice Search use cases and performance may vary for other use cases (e.g., phone call transcription). */ alternativeLanguageCodes?: string[] | null; /** - * *Optional* The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set `enable_separate_recognition_per_channel` to 'true'. + * The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set `enable_separate_recognition_per_channel` to 'true'. */ audioChannelCount?: number | null; /** - * *Optional* Config to enable speaker diarization and set additional parameters to make diarization better suited for your application. Note: When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult. + * Config to enable speaker diarization and set additional parameters to make diarization better suited for your application. Note: When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult. */ diarizationConfig?: Schema$SpeakerDiarizationConfig; /** - * *Optional* If set, specifies the estimated number of speakers in the conversation. Defaults to '2'. Ignored unless enable_speaker_diarization is set to true. Note: Use diarization_config instead. + * If set, specifies the estimated number of speakers in the conversation. Defaults to '2'. Ignored unless enable_speaker_diarization is set to true. Note: Use diarization_config instead. */ diarizationSpeakerCount?: number | null; /** - * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. + * If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. Note: This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature. */ enableAutomaticPunctuation?: boolean | null; /** @@ -240,15 +240,15 @@ export namespace speech_v1p1beta1 { */ enableSeparateRecognitionPerChannel?: boolean | null; /** - * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: Use diarization_config instead. + * If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: Use diarization_config instead. */ enableSpeakerDiarization?: boolean | null; /** - * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. + * If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean | null; /** - * *Optional* If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. + * If `true`, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If `false`, no word-level time offset information is returned. The default is `false`. */ enableWordTimeOffsets?: boolean | null; /** @@ -256,23 +256,23 @@ export namespace speech_v1p1beta1 { */ encoding?: string | null; /** - * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. + * Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. */ languageCode?: string | null; /** - * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. + * Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechRecognitionResult`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number | null; /** - * *Optional* Metadata regarding this request. + * Metadata regarding this request. */ metadata?: Schema$RecognitionMetadata; /** - * *Optional* Which 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 RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table> + * Which 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 RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table> */ model?: string | null; /** - * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. + * If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ profanityFilter?: boolean | null; /** @@ -280,11 +280,11 @@ export namespace speech_v1p1beta1 { */ sampleRateHertz?: number | null; /** - * *Optional* array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/context-strength). + * Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see [speech adaptation](https://cloud.google.com/speech-to-text/docs/context-strength). */ speechContexts?: Schema$SpeechContext[]; /** - * *Optional* Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. + * Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model. */ useEnhanced?: boolean | null; } @@ -334,15 +334,15 @@ export namespace speech_v1p1beta1 { */ export interface Schema$RecognizeRequest { /** - * *Required* The audio data to be recognized. + * Required. The audio data to be recognized. */ audio?: Schema$RecognitionAudio; /** - * *Required* Provides information to the recognizer that specifies how to process the request. + * Required. Provides information to the recognizer that specifies how to process the request. */ config?: Schema$RecognitionConfig; /** - * *Optional* The name of the model to use for recognition. + * Use `model` field in RecognitionConfig instead. */ name?: string | null; } @@ -351,24 +351,24 @@ export namespace speech_v1p1beta1 { */ export interface Schema$RecognizeResponse { /** - * Output only. Sequential list of transcription results corresponding to sequential portions of audio. + * Sequential list of transcription results corresponding to sequential portions of audio. */ results?: Schema$SpeechRecognitionResult[]; } /** - * *Optional* Config to enable speaker diarization. + * Config to enable speaker diarization. */ export interface Schema$SpeakerDiarizationConfig { /** - * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. + * If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. */ enableSpeakerDiarization?: boolean | null; /** - * *Optional* Maximum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 6. + * Maximum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 6. */ maxSpeakerCount?: number | null; /** - * *Optional* Minimum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 2. + * Minimum number of speakers in the conversation. This range gives you more flexibility by allowing the system to automatically determine the correct number of speakers. If not set, the default value is 2. */ minSpeakerCount?: number | null; } @@ -381,7 +381,7 @@ export namespace speech_v1p1beta1 { */ boost?: number | null; /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months. + * A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also be set to classes for groups of words that represent common concepts that occur in natural language. For example, rather than providing phrase hints for every month of the year, using the $MONTH class improves the likelihood of correctly transcribing audio that includes months. */ phrases?: string[] | null; } @@ -390,15 +390,15 @@ export namespace speech_v1p1beta1 { */ export interface Schema$SpeechRecognitionAlternative { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number | null; /** - * Output only. Transcript text representing the words that the user spoke. + * Transcript text representing the words that the user spoke. */ transcript?: string | null; /** - * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. + * A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio. */ words?: Schema$WordInfo[]; } @@ -407,7 +407,7 @@ export namespace speech_v1p1beta1 { */ export interface Schema$SpeechRecognitionResult { /** - * Output only. May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. + * May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer. */ alternatives?: Schema$SpeechRecognitionAlternative[]; /** @@ -415,7 +415,7 @@ export namespace speech_v1p1beta1 { */ channelTag?: number | null; /** - * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. + * The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. */ languageCode?: string | null; } @@ -441,23 +441,23 @@ export namespace speech_v1p1beta1 { */ export interface Schema$WordInfo { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number | null; /** - * Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ endTime?: string | null; /** - * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. + * A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only in the top alternative. */ speakerTag?: number | null; /** - * Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. + * Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ startTime?: string | null; /** - * Output only. The word corresponding to this set of information. + * The word corresponding to this set of information. */ word?: string | null; } diff --git a/src/apis/speech/v2beta.ts b/src/apis/speech/v2beta1.ts similarity index 97% rename from src/apis/speech/v2beta.ts rename to src/apis/speech/v2beta1.ts index 48862098541..2ea94e6c6d1 100644 --- a/src/apis/speech/v2beta.ts +++ b/src/apis/speech/v2beta1.ts @@ -36,9 +36,9 @@ import {GaxiosPromise} from 'gaxios'; // tslint:disable: jsdoc-format // tslint:disable: no-namespace -export namespace speech_v2beta { +export namespace speech_v2beta1 { export interface Options extends GlobalOptions { - version: 'v2beta'; + version: 'v2beta1'; } interface StandardParameters { @@ -95,12 +95,12 @@ export namespace speech_v2beta { * * @example * const {google} = require('googleapis'); - * const speech = google.speech('v2beta'); + * const speech = google.speech('v2beta1'); * * @namespace speech * @type {Function} - * @version v2beta - * @variation v2beta + * @version v2beta1 + * @variation v2beta1 * @param {object=} options Options for Speech */ export class Speech { @@ -243,15 +243,15 @@ export namespace speech_v2beta { /** * Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - endTime?: string | null; + endOffset?: string | null; /** - * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from `1` to `diarization_speaker_count`. speaker_tag is set if `enable_speaker_diarization` = `true` and only in the top alternative. + * Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from `1` to `diarization_config.max_speaker_count` . `speaker_tag` is set if `diarization_config.enable_speaker_diarization` = `true` and only in the top alternative. */ speakerTag?: number | null; /** * Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary. */ - startTime?: string | null; + startOffset?: string | null; /** * Output only. The word corresponding to this set of information. */ @@ -338,7 +338,7 @@ export namespace speech_v2beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -414,7 +414,7 @@ export namespace speech_v2beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta/{+name}/operations').replace( + url: (rootUrl + '/v2beta1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), diff --git a/src/apis/sql/README.md b/src/apis/sql/README.md new file mode 100644 index 00000000000..d79b9160c41 --- /dev/null +++ b/src/apis/sql/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# sql + +> API for Cloud SQL database instance management + +## 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/sql +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/sql.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/urlshortener/index.ts b/src/apis/sql/index.ts similarity index 64% rename from src/apis/urlshortener/index.ts rename to src/apis/sql/index.ts index 2d27bb8210e..8c6ff395ebc 100644 --- a/src/apis/urlshortener/index.ts +++ b/src/apis/sql/index.ts @@ -14,21 +14,19 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {urlshortener_v1} from './v1'; +import {sql_v1beta4} from './v1beta4'; export const VERSIONS = { - v1: urlshortener_v1.Urlshortener, + v1beta4: sql_v1beta4.Sql, }; -export function urlshortener(version: 'v1'): urlshortener_v1.Urlshortener; -export function urlshortener( - options: urlshortener_v1.Options -): urlshortener_v1.Urlshortener; -export function urlshortener( +export function sql(version: 'v1beta4'): sql_v1beta4.Sql; +export function sql(options: sql_v1beta4.Options): sql_v1beta4.Sql; +export function sql( this: GoogleConfigurable, - versionOrOptions: 'v1' | urlshortener_v1.Options + versionOrOptions: 'v1beta4' | sql_v1beta4.Options ) { - return getAPI('urlshortener', versionOrOptions, VERSIONS, this); + return getAPI('sql', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); diff --git a/src/apis/sql/package.json b/src/apis/sql/package.json new file mode 100644 index 00000000000..7afa6cdf980 --- /dev/null +++ b/src/apis/sql/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/sql", + "version": "0.1.0", + "description": "sql", + "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.15.0", + "typescript": "~3.6.0", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" + } +} diff --git a/src/apis/sql/tsconfig.json b/src/apis/sql/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/sql/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/sql/v1beta4.ts b/src/apis/sql/v1beta4.ts new file mode 100644 index 00000000000..7848fba7bc4 --- /dev/null +++ b/src/apis/sql/v1beta4.ts @@ -0,0 +1,5856 @@ +/** + * 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 sql_v1beta4 { + export interface Options extends GlobalOptions { + version: 'v1beta4'; + } + + 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 SQL Admin API + * + * API for Cloud SQL database instance management + * + * @example + * const {google} = require('googleapis'); + * const sql = google.sql('v1beta4'); + * + * @namespace sql + * @type {Function} + * @version v1beta4 + * @variation v1beta4 + * @param {object=} options Options for Sql + */ + export class Sql { + context: APIRequestContext; + backupRuns: Resource$Backupruns; + databases: Resource$Databases; + flags: Resource$Flags; + instances: Resource$Instances; + operations: Resource$Operations; + sslCerts: Resource$Sslcerts; + tiers: Resource$Tiers; + users: Resource$Users; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.backupRuns = new Resource$Backupruns(this.context); + this.databases = new Resource$Databases(this.context); + this.flags = new Resource$Flags(this.context); + this.instances = new Resource$Instances(this.context); + this.operations = new Resource$Operations(this.context); + this.sslCerts = new Resource$Sslcerts(this.context); + this.tiers = new Resource$Tiers(this.context); + this.users = new Resource$Users(this.context); + } + } + + /** + * An entry for an Access Control list. + */ + export interface Schema$AclEntry { + /** + * The time when this access control entry expires in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + expirationTime?: string | null; + /** + * This is always <code>sql#aclEntry</code>. + */ + kind?: string | null; + /** + * An optional label to identify this entry. + */ + name?: string | null; + /** + * The whitelisted value for the access control list. + */ + value?: string | null; + } + /** + * An Admin API warning message. + */ + export interface Schema$ApiWarning { + /** + * Code to uniquely identify the warning type. + */ + code?: string | null; + /** + * The warning message. + */ + message?: string | null; + } + /** + * Database instance backup configuration. + */ + export interface Schema$BackupConfiguration { + /** + * Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well. + */ + binaryLogEnabled?: boolean | null; + /** + * Whether this configuration is enabled. + */ + enabled?: boolean | null; + /** + * This is always <code>sql#backupConfiguration</code>. + */ + kind?: string | null; + /** + * Location of the backup + */ + location?: string | null; + /** + * Reserved for future use. + */ + replicationLogArchivingEnabled?: boolean | null; + /** + * Start time for the daily backup configuration in UTC timezone in the 24 hour format - <code>HH:MM</code>. + */ + startTime?: string | null; + } + /** + * A BackupRun resource. + */ + export interface Schema$BackupRun { + /** + * The description of this run, only applicable to on-demand backups. + */ + description?: string | null; + /** + * Encryption configuration specific to a backup. Applies only to Second Generation instances. + */ + diskEncryptionConfiguration?: Schema$DiskEncryptionConfiguration; + /** + * Encryption status specific to a backup. Applies only to Second Generation instances. + */ + diskEncryptionStatus?: Schema$DiskEncryptionStatus; + /** + * The time the backup operation completed in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + endTime?: string | null; + /** + * The time the run was enqueued in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + enqueuedTime?: string | null; + /** + * Information about why the backup operation failed. This is only present if the run has the FAILED status. + */ + error?: Schema$OperationError; + /** + * The identifier for this backup run. Unique only for a specific Cloud SQL instance. + */ + id?: string | null; + /** + * Name of the database instance. + */ + instance?: string | null; + /** + * This is always <code>sql#backupRun</code>. + */ + kind?: string | null; + /** + * Location of the backups. + */ + location?: string | null; + /** + * The URI of this resource. + */ + selfLink?: string | null; + /** + * The time the backup operation actually started in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + startTime?: string | null; + /** + * The status of this run. + */ + status?: string | null; + /** + * The type of this run; can be either "AUTOMATED" or "ON_DEMAND". + */ + type?: string | null; + /** + * The start time of the backup window during which this the backup was attempted in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + windowStartTime?: string | null; + } + /** + * Backup run list results. + */ + export interface Schema$BackupRunsListResponse { + /** + * A list of backup runs in reverse chronological order of the enqueued time. + */ + items?: Schema$BackupRun[]; + /** + * This is always <code>sql#backupRunsList</code>. + */ + kind?: string | null; + /** + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Binary log coordinates. + */ + export interface Schema$BinLogCoordinates { + /** + * Name of the binary log file for a Cloud SQL instance. + */ + binLogFileName?: string | null; + /** + * Position (offset) within the binary log file. + */ + binLogPosition?: string | null; + /** + * This is always <code>sql#binLogCoordinates</code>. + */ + kind?: string | null; + } + /** + * Database instance clone context. + */ + export interface Schema$CloneContext { + /** + * Binary log coordinates, if specified, identify the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates. + */ + binLogCoordinates?: Schema$BinLogCoordinates; + /** + * Name of the Cloud SQL instance to be created as a clone. + */ + destinationInstanceName?: string | null; + /** + * This is always <code>sql#cloneContext</code>. + */ + kind?: string | null; + /** + * Reserved for future use. + */ + pitrTimestampMs?: string | null; + } + /** + * Represents a SQL database on the Cloud SQL instance. + */ + export interface Schema$Database { + /** + * The MySQL charset value. + */ + charset?: string | null; + /** + * The MySQL collation value. + */ + collation?: string | null; + /** + * This field is deprecated and will be removed from a future version of the API. + */ + etag?: string | null; + /** + * The name of the Cloud SQL instance. This does not include the project ID. + */ + instance?: string | null; + /** + * This is always <code>sql#database</code>. + */ + kind?: string | null; + /** + * The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. + */ + name?: string | null; + /** + * The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. + */ + project?: string | null; + /** + * The URI of this resource. + */ + selfLink?: string | null; + sqlserverDatabaseDetails?: Schema$SqlServerDatabaseDetails; + } + /** + * Database flags for Cloud SQL instances. + */ + export interface Schema$DatabaseFlags { + /** + * The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags should be specified with underscores, not hyphens. For more information, see <a href="/sql/docs/mysql/flags">Configuring Database Flags</a> in the Cloud SQL documentation. + */ + name?: string | null; + /** + * The value of the flag. Booleans should be set to <code>on</code> for true and <code>off</code> for false. This field must be omitted if the flag doesn't take a value. + */ + value?: string | null; + } + /** + * A Cloud SQL instance resource. If you change this, also change SqlDatabaseInstance + */ + export interface Schema$DatabaseInstance { + /** + * <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL instance. <br /><code>EXTERNAL</code>: A database server that is not managed by Google. <br>This property is read-only; use the <code>tier</code> property in the <code>settings</code> object to determine the database type and Second or First Generation. + */ + backendType?: string | null; + /** + * Connection name of the Cloud SQL instance used in connection strings. + */ + connectionName?: string | null; + /** + * The current disk usage of the instance in bytes. This property has been deprecated. Users should use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see <a href="https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ">this announcement</a> for details. + */ + currentDiskSize?: string | null; + /** + * The database engine type and version. The <code>databaseVersion</code> field can not be changed after instance creation. MySQL Second Generation instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>. PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or <code>POSTGRES_11 Beta</code> MySQL First Generation instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code> + */ + databaseVersion?: string | null; + /** + * Disk encryption configuration specific to an instance. Applies only to Second Generation instances. + */ + diskEncryptionConfiguration?: Schema$DiskEncryptionConfiguration; + /** + * Disk encryption status specific to an instance. Applies only to Second Generation instances. + */ + diskEncryptionStatus?: Schema$DiskEncryptionStatus; + /** + * This field is deprecated and will be removed from a future version of the API. Use the <code>settings.settingsVersion</code> field instead. + */ + etag?: string | null; + /** + * The name and status of the failover replica. This property is applicable only to Second Generation instances. + */ + failoverReplica?: {name?: string; available?: boolean} | null; + /** + * The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. + */ + gceZone?: string | null; + /** + * The instance type. This can be one of the following. <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An instance running on the customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL instance configured as a read-replica. + */ + instanceType?: string | null; + /** + * The assigned IP addresses for the instance. + */ + ipAddresses?: Schema$IpMapping[]; + /** + * The IPv6 address assigned to the instance. This property is applicable only to First Generation instances. + */ + ipv6Address?: string | null; + /** + * This is always <code>sql#instance</code>. + */ + kind?: string | null; + /** + * The name of the instance which will act as master in the replication setup. + */ + masterInstanceName?: string | null; + /** + * The maximum disk size of the instance in bytes. + */ + maxDiskSize?: string | null; + /** + * Name of the Cloud SQL instance. This does not include the project ID. + */ + name?: string | null; + /** + * Configuration specific to on-premises instances. + */ + onPremisesConfiguration?: Schema$OnPremisesConfiguration; + /** + * The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. + */ + project?: string | null; + /** + * The geographical region. Can be <code>us-central</code> (<code>FIRST_GEN</code> instances only), <code>us-central1</code> (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or <code>europe-west1</code>. Defaults to <code>us-central</code> or <code>us-central1</code> depending on the instance type (First Generation or Second Generation). The region can not be changed after instance creation. + */ + region?: string | null; + /** + * Configuration specific to failover replicas and read replicas. + */ + replicaConfiguration?: Schema$ReplicaConfiguration; + /** + * The replicas of the instance. + */ + replicaNames?: string[] | null; + /** + * Initial root password. Use only on creation. + */ + rootPassword?: string | null; + /** + * The start time of any upcoming scheduled maintenance for this instance. + */ + scheduledMaintenance?: Schema$SqlScheduledMaintenance; + /** + * The URI of this resource. + */ + selfLink?: string | null; + /** + * SSL configuration. + */ + serverCaCert?: Schema$SslCert; + /** + * The service account email address assigned to the instance. This property is applicable only to Second Generation instances. + */ + serviceAccountEmailAddress?: string | null; + /** + * The user settings. + */ + settings?: Schema$Settings; + /** + * The current serving state of the Cloud SQL instance. This can be one of the following. <br><code>RUNNABLE</code>: The instance is running, or is ready to run when accessed. <br><code>SUSPENDED</code>: The instance is not available, for example due to problems with billing. <br><code>PENDING_CREATE</code>: The instance is being created. <br><code>MAINTENANCE</code>: The instance is down for maintenance. <br><code>FAILED</code>: The instance creation failed. <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown. + */ + state?: string | null; + /** + * If the instance state is SUSPENDED, the reason for the suspension. + */ + suspensionReason?: string[] | null; + } + /** + * Database list response. + */ + export interface Schema$DatabasesListResponse { + /** + * List of database resources in the instance. + */ + items?: Schema$Database[]; + /** + * This is always <code>sql#databasesList</code>. + */ + kind?: string | null; + } + /** + * Read-replica configuration for connecting to the on-premises master. + */ + export interface Schema$DemoteMasterConfiguration { + /** + * This is always <code>sql#demoteMasterConfiguration</code>. + */ + kind?: string | null; + /** + * MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named <code>master.info</code> in the data directory. + */ + mysqlReplicaConfiguration?: Schema$DemoteMasterMySqlReplicaConfiguration; + } + /** + * Database instance demote master context. + */ + export interface Schema$DemoteMasterContext { + /** + * This is always <code>sql#demoteMasterContext</code>. + */ + kind?: string | null; + /** + * The name of the instance which will act as on-premises master in the replication setup. + */ + masterInstanceName?: string | null; + /** + * Configuration specific to read-replicas replicating from the on-premises master. + */ + replicaConfiguration?: Schema$DemoteMasterConfiguration; + /** + * Verify GTID consistency for demote operation. Default value: <code>True</code>. Second Generation instances only. Setting this flag to false enables you to bypass GTID consistency check between on-premises master and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues. + */ + verifyGtidConsistency?: boolean | null; + } + /** + * Read-replica configuration specific to MySQL databases. + */ + export interface Schema$DemoteMasterMySqlReplicaConfiguration { + /** + * PEM representation of the trusted CA's x509 certificate. + */ + caCertificate?: string | null; + /** + * PEM representation of the slave's x509 certificate. + */ + clientCertificate?: string | null; + /** + * PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. The format of the slave's private key can be either PKCS #1 or PKCS #8. + */ + clientKey?: string | null; + /** + * This is always <code>sql#demoteMasterMysqlReplicaConfiguration</code>. + */ + kind?: string | null; + /** + * The password for the replication connection. + */ + password?: string | null; + /** + * The username for the replication connection. + */ + username?: string | null; + } + /** + * Disk encryption configuration for an instance. + */ + export interface Schema$DiskEncryptionConfiguration { + /** + * This is always <code>sql#diskEncryptionConfiguration</code>. + */ + kind?: string | null; + /** + * Resource name of KMS key for disk encryption + */ + kmsKeyName?: string | null; + } + /** + * Disk encryption status for an instance. + */ + export interface Schema$DiskEncryptionStatus { + /** + * This is always <code>sql#diskEncryptionStatus</code>. + */ + kind?: string | null; + /** + * KMS key version used to encrypt the Cloud SQL instance resource + */ + kmsKeyVersionName?: string | null; + } + /** + * Database instance export context. + */ + export interface Schema$ExportContext { + /** + * Options for exporting data as CSV. + */ + csvExportOptions?: {selectQuery?: string} | null; + /** + * Databases to be exported. <br /> <b>MySQL instances:</b> If <code>fileType</code> is <code>SQL</code> and no database is specified, all databases are exported, except for the <code>mysql</code> system database. If <code>fileType</code> is <code>CSV</code>, you can specify one database, either by using this property or by using the <code>csvExportOptions.selectQuery</code> property, which takes precedence over this property. <br /> <b>PostgreSQL instances:</b> You must specify one database to be exported. If <code>fileType</code> is <code>CSV</code>, this database must match the one specified in the <code>csvExportOptions.selectQuery</code> property. + */ + databases?: string[] | null; + /** + * The file type for the specified uri. <br><code>SQL</code>: The file contains SQL statements. <br><code>CSV</code>: The file contains CSV data. + */ + fileType?: string | null; + /** + * This is always <code>sql#exportContext</code>. + */ + kind?: string | null; + /** + * Options for exporting data as SQL statements. + */ + sqlExportOptions?: { + schemaOnly?: boolean; + mysqlExportOptions?: {masterData?: number}; + tables?: string[]; + } | null; + /** + * The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form <code>gs: //bucketName/fileName</code>. If the file already exists, the requests // succeeds, but the operation fails. If <code>fileType</code> is // <code>SQL</code> and the filename ends with .gz, the contents are // compressed. + */ + uri?: string | null; + } + /** + * Database instance failover context. + */ + export interface Schema$FailoverContext { + /** + * This is always <code>sql#failoverContext</code>. + */ + kind?: string | null; + /** + * The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. + */ + settingsVersion?: string | null; + } + /** + * A flag resource. + */ + export interface Schema$Flag { + /** + * For <code>STRING</code> flags, a list of strings that the value can be set to. + */ + allowedStringValues?: string[] | null; + /** + * The database version this flag applies to. Can be <code>MYSQL_5_5</code>, <code>MYSQL_5_6</code>, or <code>MYSQL_5_7</code>. <code>MYSQL_5_7</code> is applicable only to Second Generation instances. + */ + appliesTo?: string[] | null; + /** + * Whether or not the flag is considered in beta. + */ + inBeta?: boolean | null; + /** + * This is always <code>sql#flag</code>. + */ + kind?: string | null; + /** + * For <code>INTEGER</code> flags, the maximum allowed value. + */ + maxValue?: string | null; + /** + * For <code>INTEGER</code> flags, the minimum allowed value. + */ + minValue?: string | null; + /** + * This is the name of the flag. Flag names always use underscores, not hyphens, e.g. <code>max_allowed_packet</code> + */ + name?: string | null; + /** + * Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. + */ + requiresRestart?: boolean | null; + /** + * The type of the flag. Flags are typed to being <code>BOOLEAN</code>, <code>STRING</code>, <code>INTEGER</code> or <code>NONE</code>. <code>NONE</code> is used for flags which do not take a value, such as <code>skip_grant_tables</code>. + */ + type?: string | null; + } + /** + * Flags list response. + */ + export interface Schema$FlagsListResponse { + /** + * List of flags. + */ + items?: Schema$Flag[]; + /** + * This is always <code>sql#flagsList</code>. + */ + kind?: string | null; + } + /** + * Database instance import context. + */ + export interface Schema$ImportContext { + /** + * Import parameters specific to SQL Server .BAK files + */ + bakImportOptions?: { + encryptionOptions?: { + certPath?: string; + pvkPath?: string; + pvkPassword?: string; + }; + } | null; + /** + * Options for importing data as CSV. + */ + csvImportOptions?: {table?: string; columns?: string[]} | null; + /** + * The target database for the import. If <code>fileType</code> is <code>SQL</code>, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If <code>fileType</code> is <code>CSV</code>, one database must be specified. + */ + database?: string | null; + /** + * The file type for the specified uri. <br><code>SQL</code>: The file contains SQL statements. <br><code>CSV</code>: The file contains CSV data. + */ + fileType?: string | null; + /** + * The PostgreSQL user for this import operation. PostgreSQL instances only. + */ + importUser?: string | null; + /** + * This is always <code>sql#importContext</code>. + */ + kind?: string | null; + /** + * Path to the import file in Cloud Storage, in the form <code>gs: //bucketName/fileName</code>. Compressed gzip files (.gz) are supported // when <code>fileType</code> is <code>SQL</code>. The instance must have // write permissions to the bucket and read access to the file. + */ + uri?: string | null; + } + /** + * Database instance clone request. + */ + export interface Schema$InstancesCloneRequest { + /** + * Contains details about the clone operation. + */ + cloneContext?: Schema$CloneContext; + } + /** + * Database demote master request. + */ + export interface Schema$InstancesDemoteMasterRequest { + /** + * Contains details about the demoteMaster operation. + */ + demoteMasterContext?: Schema$DemoteMasterContext; + } + /** + * Database instance export request. + */ + export interface Schema$InstancesExportRequest { + /** + * Contains details about the export operation. + */ + exportContext?: Schema$ExportContext; + } + /** + * Instance failover request. + */ + export interface Schema$InstancesFailoverRequest { + /** + * Failover Context. + */ + failoverContext?: Schema$FailoverContext; + } + /** + * Database instance import request. + */ + export interface Schema$InstancesImportRequest { + /** + * Contains details about the import operation. + */ + importContext?: Schema$ImportContext; + } + /** + * Database instances list response. + */ + export interface Schema$InstancesListResponse { + /** + * List of database instance resources. + */ + items?: Schema$DatabaseInstance[]; + /** + * This is always <code>sql#instancesList</code>. + */ + kind?: string | null; + /** + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + */ + nextPageToken?: string | null; + /** + * List of warnings that ocurred while handling the request. + */ + warnings?: Schema$ApiWarning[]; + } + /** + * Instances ListServerCas response. + */ + export interface Schema$InstancesListServerCasResponse { + activeVersion?: string | null; + /** + * List of server CA certificates for the instance. + */ + certs?: Schema$SslCert[]; + /** + * This is always <code>sql#instancesListServerCas</code>. + */ + kind?: string | null; + } + /** + * Database instance restore backup request. + */ + export interface Schema$InstancesRestoreBackupRequest { + /** + * Parameters required to perform the restore backup operation. + */ + restoreBackupContext?: Schema$RestoreBackupContext; + } + /** + * Rotate Server CA request. + */ + export interface Schema$InstancesRotateServerCaRequest { + /** + * Contains details about the rotate server CA operation. + */ + rotateServerCaContext?: Schema$RotateServerCaContext; + } + /** + * Instance truncate log request. + */ + export interface Schema$InstancesTruncateLogRequest { + /** + * Contains details about the truncate log operation. + */ + truncateLogContext?: Schema$TruncateLogContext; + } + /** + * IP Management configuration. + */ + export interface Schema$IpConfiguration { + /** + * The list of external networks that are allowed to connect to the instance using the IP. In <a href="http://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation">CIDR notation</a>, also known as 'slash' notation (e.g. <code>192.168.100.0/24</code>). + */ + authorizedNetworks?: Schema$AclEntry[]; + /** + * Whether the instance should be assigned an IP address or not. + */ + ipv4Enabled?: boolean | null; + /** + * The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, <code>/projects/myProject/global/networks/default</code>. This setting can be updated, but it cannot be removed after it is set. + */ + privateNetwork?: string | null; + /** + * Whether SSL connections over IP should be enforced or not. + */ + requireSsl?: boolean | null; + } + /** + * Database instance IP Mapping. + */ + export interface Schema$IpMapping { + /** + * The IP address assigned. + */ + ipAddress?: string | null; + /** + * The due time for this IP to be retired in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. This field is only available when the IP is scheduled to be retired. + */ + timeToRetire?: string | null; + /** + * The type of this IP address. A <code>PRIMARY</code> address is a public address that can accept incoming connections. A <code>PRIVATE</code> address is a private address that can accept incoming connections. An <code>OUTGOING</code> address is the source address of connections originating from the instance, if supported. + */ + type?: string | null; + } + /** + * Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. + */ + export interface Schema$LocationPreference { + /** + * The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. + */ + followGaeApplication?: string | null; + /** + * This is always <code>sql#locationPreference</code>. + */ + kind?: string | null; + /** + * The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b, etc.). + */ + zone?: string | null; + } + /** + * Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance purposes. + */ + export interface Schema$MaintenanceWindow { + /** + * day of week (1-7), starting on Monday. + */ + day?: number | null; + /** + * hour of day - 0 to 23. + */ + hour?: number | null; + /** + * This is always <code>sql#maintenanceWindow</code>. + */ + kind?: string | null; + /** + * Maintenance timing setting: <code>canary</code> (Earlier) or <code>stable</code> (Later). <br /><a href="/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen"> Learn more</a>. + */ + updateTrack?: string | null; + } + /** + * Read-replica configuration specific to MySQL databases. + */ + export interface Schema$MySqlReplicaConfiguration { + /** + * PEM representation of the trusted CA's x509 certificate. + */ + caCertificate?: string | null; + /** + * PEM representation of the slave's x509 certificate. + */ + clientCertificate?: string | null; + /** + * PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. + */ + clientKey?: string | null; + /** + * Seconds to wait between connect retries. MySQL's default is 60 seconds. + */ + connectRetryInterval?: number | null; + /** + * Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs: //bucketName/fileName. Compressed gzip files (.gz) are also supported. // Dumps should have the binlog co-ordinates from which replication should // begin. This can be accomplished by setting --master-data to 1 when using // mysqldump. + */ + dumpFilePath?: string | null; + /** + * This is always <code>sql#mysqlReplicaConfiguration</code>. + */ + kind?: string | null; + /** + * Interval in milliseconds between replication heartbeats. + */ + masterHeartbeatPeriod?: string | null; + /** + * The password for the replication connection. + */ + password?: string | null; + /** + * A list of permissible ciphers to use for SSL encryption. + */ + sslCipher?: string | null; + /** + * The username for the replication connection. + */ + username?: string | null; + /** + * Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake. + */ + verifyServerCertificate?: boolean | null; + } + /** + * On-premises instance configuration. + */ + export interface Schema$OnPremisesConfiguration { + /** + * The host and port of the on-premises instance in host:port format + */ + hostPort?: string | null; + /** + * This is always <code>sql#onPremisesConfiguration</code>. + */ + kind?: 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. + */ + export interface Schema$Operation { + /** + * The time this operation finished in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + endTime?: string | null; + /** + * If errors occurred during processing of this operation, this field will be populated. + */ + error?: Schema$OperationErrors; + /** + * The context for export operation, if applicable. + */ + exportContext?: Schema$ExportContext; + /** + * The context for import operation, if applicable. + */ + importContext?: Schema$ImportContext; + /** + * The time this operation was enqueued in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + insertTime?: string | null; + /** + * This is always <code>sql#operation</code>. + */ + kind?: string | null; + /** + * An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. + */ + name?: string | null; + /** + * The type of the operation. Valid values are <code>CREATE</code>, <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>, <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>, <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>, <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>, <code>DELETE_DATABASE</code> . + */ + operationType?: string | null; + /** + * The URI of this resource. + */ + selfLink?: string | null; + /** + * The time this operation actually started in UTC timezone in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + startTime?: string | null; + /** + * The status of an operation. Valid values are <code>PENDING</code>, <code>RUNNING</code>, <code>DONE</code>, <code>UNKNOWN</code>. + */ + status?: string | null; + /** + * Name of the database instance related to this operation. + */ + targetId?: string | null; + targetLink?: string | null; + /** + * The project ID of the target instance related to this operation. + */ + targetProject?: string | null; + /** + * The email address of the user who initiated this operation. + */ + user?: string | null; + } + /** + * Database instance operation error. + */ + export interface Schema$OperationError { + /** + * Identifies the specific error that occurred. + */ + code?: string | null; + /** + * This is always <code>sql#operationError</code>. + */ + kind?: string | null; + /** + * Additional information about the error encountered. + */ + message?: string | null; + } + /** + * Database instance operation errors list wrapper. + */ + export interface Schema$OperationErrors { + /** + * The list of errors encountered while processing this operation. + */ + errors?: Schema$OperationError[]; + /** + * This is always <code>sql#operationErrors</code>. + */ + kind?: string | null; + } + /** + * Database instance list operations response. + */ + export interface Schema$OperationsListResponse { + /** + * List of operation resources. + */ + items?: Schema$Operation[]; + /** + * This is always <code>sql#operationsList</code>. + */ + kind?: string | null; + /** + * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Read-replica configuration for connecting to the master. + */ + export interface Schema$ReplicaConfiguration { + /** + * Specifies if the replica is the failover target. If the field is set to <code>true</code> the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. <p>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. + */ + failoverTarget?: boolean | null; + /** + * This is always <code>sql#replicaConfiguration</code>. + */ + kind?: string | null; + /** + * MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named <code>master.info</code> in the data directory. + */ + mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration; + } + /** + * Database instance restore from backup context. Backup context contains source instance id and project id. + */ + export interface Schema$RestoreBackupContext { + /** + * The ID of the backup run to restore from. + */ + backupRunId?: string | null; + /** + * The ID of the instance that the backup was taken from. + */ + instanceId?: string | null; + /** + * This is always <code>sql#restoreBackupContext</code>. + */ + kind?: string | null; + /** + * The full project ID of the source instance. + */ + project?: string | null; + } + /** + * Instance rotate server CA context. + */ + export interface Schema$RotateServerCaContext { + /** + * This is always <code>sql#rotateServerCaContext</code>. + */ + kind?: string | null; + /** + * The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server CA version. + */ + nextVersion?: string | null; + } + /** + * Database instance settings. + */ + export interface Schema$Settings { + /** + * The activation policy specifies when the instance is activated; it is applicable only when the instance state is <code>RUNNABLE</code>. Valid values: <br><code>ALWAYS</code>: The instance is on, and remains so even in the absence of connection requests. <br><code>NEVER</code>: The instance is off; it is not activated, even if a connection request arrives. <br><code>ON_DEMAND</code>: First Generation instances only. The instance responds to incoming requests, and turns itself off when not in use. Instances with <code>PER_USE</code> pricing turn off after 15 minutes of inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after 12 hours of inactivity. + */ + activationPolicy?: string | null; + /** + * The App Engine app IDs that can access this instance. First Generation instances only. + */ + authorizedGaeApplications?: string[] | null; + /** + * Availability type (PostgreSQL instances only). Potential values: <br><code>ZONAL</code>: The instance serves data from only one zone. Outages in that zone affect data accessibility. <br><code>REGIONAL</code>: The instance can serve data from more than one zone in a region (it is highly available). <br>For more information, see <a href="https://cloud.google.com/sql/docs/postgres/high-availability">Overview of the High Availability Configuration</a>. + */ + availabilityType?: string | null; + /** + * The daily backup configuration for the instance. + */ + backupConfiguration?: Schema$BackupConfiguration; + /** + * Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property is only applicable to First Generation instances. + */ + crashSafeReplicationEnabled?: boolean | null; + /** + * The database flags passed to the instance at startup. + */ + databaseFlags?: Schema$DatabaseFlags[]; + /** + * Configuration specific to read replica instances. Indicates whether replication is enabled or not. + */ + databaseReplicationEnabled?: boolean | null; + /** + * The size of data disk, in GB. The data disk size minimum is 10GB. Not used for First Generation instances. + */ + dataDiskSizeGb?: string | null; + /** + * The type of data disk: <code>PD_SSD</code> (default) or <code>PD_HDD</code>. Not used for First Generation instances. + */ + dataDiskType?: string | null; + /** + * The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. + */ + ipConfiguration?: Schema$IpConfiguration; + /** + * This is always <code>sql#settings</code>. + */ + kind?: string | null; + /** + * The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location is only applicable to First Generation instances. + */ + locationPreference?: Schema$LocationPreference; + /** + * The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. Not used for First Generation instances. + */ + maintenanceWindow?: Schema$MaintenanceWindow; + /** + * The pricing plan for this instance. This can be either <code>PER_USE</code> or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second Generation instances. + */ + pricingPlan?: string | null; + /** + * The type of replication this instance uses. This can be either <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is only applicable to First Generation instances. + */ + replicationType?: string | null; + /** + * The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. + */ + settingsVersion?: string | null; + /** + * Configuration to increase storage size automatically. The default value is true. Not used for First Generation instances. + */ + storageAutoResize?: boolean | null; + /** + * The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. Not used for First Generation instances. + */ + storageAutoResizeLimit?: string | null; + /** + * The tier (or machine type) for this instance, for example <code>db-n1-standard-1</code> (MySQL instances) or <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances, this property determines whether the instance is First or Second Generation. For more information, see <a href="/sql/docs/db_path/instance-settings">Instance Settings</a>. + */ + tier?: string | null; + /** + * User-provided labels, represented as a dictionary where each label is a single key value pair. + */ + userLabels?: {[key: string]: string} | null; + } + /** + * Any scheduled maintenancce for this instance. + */ + export interface Schema$SqlScheduledMaintenance { + /** + * If the scheduled maintenance can be deferred. + */ + canDefer?: boolean | null; + /** + * The start time of any upcoming scheduled maintenance for this instance. + */ + startTime?: string | null; + } + /** + * Represents a Sql Server database on the Cloud SQL instance. + */ + export interface Schema$SqlServerDatabaseDetails { + /** + * The version of SQL Server with which the database is to be made compatible + */ + compatibilityLevel?: number | null; + /** + * The recovery model of a SQL Server database + */ + recoveryModel?: string | null; + } + /** + * SslCerts Resource + */ + export interface Schema$SslCert { + /** + * PEM representation. + */ + cert?: string | null; + /** + * Serial number, as extracted from the certificate. + */ + certSerialNumber?: string | null; + /** + * User supplied name. Constrained to [a-zA-Z.-_ ]+. + */ + commonName?: string | null; + /** + * The time when the certificate was created in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code> + */ + createTime?: string | null; + /** + * The time when the certificate expires in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. + */ + expirationTime?: string | null; + /** + * Name of the database instance. + */ + instance?: string | null; + /** + * This is always <code>sql#sslCert</code>. + */ + kind?: string | null; + /** + * The URI of this resource. + */ + selfLink?: string | null; + /** + * Sha1 Fingerprint. + */ + sha1Fingerprint?: string | null; + } + /** + * SslCertDetail. + */ + export interface Schema$SslCertDetail { + /** + * The public information about the cert. + */ + certInfo?: Schema$SslCert; + /** + * The private key for the client cert, in pem format. Keep private in order to protect your security. + */ + certPrivateKey?: string | null; + } + /** + * SslCerts create ephemeral certificate request. + */ + export interface Schema$SslCertsCreateEphemeralRequest { + /** + * PEM encoded public key to include in the signed certificate. + */ + public_key?: string | null; + } + /** + * SslCerts insert request. + */ + export interface Schema$SslCertsInsertRequest { + /** + * User supplied name. Must be a distinct name from the other certificates for this instance. + */ + commonName?: string | null; + } + /** + * SslCert insert response. + */ + export interface Schema$SslCertsInsertResponse { + /** + * The new client certificate and private key. For First Generation instances, the new certificate does not take effect until the instance is restarted. + */ + clientCert?: Schema$SslCertDetail; + /** + * This is always <code>sql#sslCertsInsert</code>. + */ + kind?: string | null; + /** + * The operation to track the ssl certs insert request. + */ + operation?: Schema$Operation; + /** + * The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource. + */ + serverCaCert?: Schema$SslCert; + } + /** + * SslCerts list response. + */ + export interface Schema$SslCertsListResponse { + /** + * List of client certificates for the instance. + */ + items?: Schema$SslCert[]; + /** + * This is always <code>sql#sslCertsList</code>. + */ + kind?: string | null; + } + /** + * A Google Cloud SQL service tier resource. + */ + export interface Schema$Tier { + /** + * The maximum disk size of this tier in bytes. + */ + DiskQuota?: string | null; + /** + * This is always <code>sql#tier</code>. + */ + kind?: string | null; + /** + * The maximum RAM usage of this tier in bytes. + */ + RAM?: string | null; + /** + * The applicable regions for this tier. + */ + region?: string[] | null; + /** + * An identifier for the machine type, for example, db-n1-standard-1. For related information, see <a href="/sql/pricing">Pricing</a>. + */ + tier?: string | null; + } + /** + * Tiers list response. + */ + export interface Schema$TiersListResponse { + /** + * List of tiers. + */ + items?: Schema$Tier[]; + /** + * This is always <code>sql#tiersList</code>. + */ + kind?: string | null; + } + /** + * Database Instance truncate log context. + */ + export interface Schema$TruncateLogContext { + /** + * This is always <code>sql#truncateLogContext</code>. + */ + kind?: string | null; + /** + * The type of log to truncate. Valid values are <code>MYSQL_GENERAL_TABLE</code> and <code>MYSQL_SLOW_TABLE</code>. + */ + logType?: string | null; + } + /** + * A Cloud SQL user resource. + */ + export interface Schema$User { + /** + * This field is deprecated and will be removed from a future version of the API. + */ + etag?: string | null; + /** + * The host name from which the user can connect. For <code>insert</code> operations, host defaults to an empty string. For <code>update</code> operations, host is specified as part of the request URL. The host name cannot be updated after insertion. + */ + host?: string | null; + /** + * The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for <code>update</code> since it is already specified on the URL. + */ + instance?: string | null; + /** + * This is always <code>sql#user</code>. + */ + kind?: string | null; + /** + * The name of the user in the Cloud SQL instance. Can be omitted for <code>update</code> since it is already specified in the URL. + */ + name?: string | null; + /** + * The password for the user. + */ + password?: string | null; + /** + * 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; + } + /** + * User list response. + */ + export interface Schema$UsersListResponse { + /** + * List of user resources in the instance. + */ + items?: Schema$User[]; + /** + * This is always <code>sql#usersList</code>. + */ + kind?: string | null; + /** + * An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. + */ + nextPageToken?: string | null; + } + + export class Resource$Backupruns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.backupRuns.delete + * @desc Deletes the backup taken by a backup run. + * @alias sql.backupRuns.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the backupRun to delete. Format: projects/{project}/locations/{location}/instances/{instance}/backupRuns/{backupRun} + * @param {object} [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$Backupruns$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Backupruns$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Backupruns$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Backupruns$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backupruns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Delete; + 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}/backupRuns/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'id'], + pathParams: ['id', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.backupRuns.get + * @desc Retrieves a resource containing information about a backup run. + * @alias sql.backupRuns.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id The ID of this Backup Run. + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName Name of the resource backupRun. Format: projects/{project}/locations/{location}/instances/{instance}/backupRuns/{backupRun} + * @param {object} [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$Backupruns$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Backupruns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Backupruns$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Backupruns$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Get; + 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}/backupRuns/{id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'id'], + pathParams: ['id', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.backupRuns.insert + * @desc Creates a new backup run on demand. This method is applicable only to Second Generation instances. + * @alias sql.backupRuns.insert + * @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 should create this backupRun. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {().BackupRun} params.resource Request body data + * @param {object} [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$Backupruns$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Backupruns$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Backupruns$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Backupruns$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backupruns$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$Insert; + 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}/backupRuns' + ).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.backupRuns.list + * @desc Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time. + * @alias sql.backupRuns.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {integer=} params.maxResults Maximum number of backup runs 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 backupRuns. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Backupruns$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Backupruns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Backupruns$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Backupruns$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Backupruns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backupruns$List; + 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}/backupRuns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Backupruns$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. + */ + id?: string; + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of the backupRun to delete. Format: projects/{project}/locations/{location}/instances/{instance}/backupRuns/{backupRun} + */ + resourceName?: string; + } + export interface Params$Resource$Backupruns$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of this Backup Run. + */ + id?: string; + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * Name of the resource backupRun. Format: projects/{project}/locations/{location}/instances/{instance}/backupRuns/{backupRun} + */ + resourceName?: string; + } + export interface Params$Resource$Backupruns$Insert + 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 should create this backupRun. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupRun; + } + export interface Params$Resource$Backupruns$List 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; + /** + * Maximum number of backup runs per response. + */ + maxResults?: number; + /** + * A previously-returned page token representing part of the larger set of results to view. + */ + pageToken?: string; + /** + * The parent, which owns this collection of backupRuns. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + + export class Resource$Databases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.databases.delete + * @desc Deletes a database from a Cloud SQL instance. + * @alias sql.databases.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.database Name of the database to be deleted in the instance. + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the database to delete. Format: projects/{project}/locations/{location}/instances/{instance}/databases/{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 + */ + delete( + params?: Params$Resource$Databases$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Databases$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Databases$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Databases$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Databases$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Databases$Delete; + 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}/databases/{database}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'database'], + pathParams: ['database', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.databases.get + * @desc Retrieves a resource containing information about a database inside a Cloud SQL instance. + * @alias sql.databases.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.database Name of the database in the instance. + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName Name of the resource database. Format: projects/{project}/locations/{location}/instances/{instance}/databases/{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 + */ + get( + params?: Params$Resource$Databases$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Databases$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Databases$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Databases$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Databases$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Databases$Get; + 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}/databases/{database}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'database'], + pathParams: ['database', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.databases.insert + * @desc Inserts a resource containing information about a database inside a Cloud SQL instance. + * @alias sql.databases.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string=} params.parent The parent resource where Cloud SQL should add this database. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {().Database} params.resource Request body data + * @param {object} [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$Databases$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Databases$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Databases$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Databases$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Databases$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Databases$Insert; + 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}/databases' + ).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.databases.list + * @desc Lists databases in the specified Cloud SQL instance. + * @alias sql.databases.list + * @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, which owns this collection of databases. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Databases$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Databases$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Databases$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Databases$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Databases$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Databases$List; + 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}/databases' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.databases.patch + * @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! () + * + * @param {object} params Parameters for request + * @param {string} params.database Name of the database to be updated in the instance. + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the database for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance}/databases/{database} + * @param {().Database} params.resource Request body data + * @param {object} [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$Databases$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Databases$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Databases$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Databases$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Databases$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Databases$Patch; + 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}/databases/{database}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'database'], + pathParams: ['database', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.databases.update + * @desc Updates a resource containing information about a database inside a Cloud SQL instance. + * @alias sql.databases.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.database Name of the database to be updated in the instance. + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the database for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance}/databases/{database} + * @param {().Database} params.resource Request body data + * @param {object} [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$Databases$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Databases$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Databases$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Databases$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Databases$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Databases$Update; + 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}/databases/{database}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'database'], + pathParams: ['database', 'instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Databases$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the database to be deleted in the instance. + */ + database?: string; + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of the database to delete. Format: projects/{project}/locations/{location}/instances/{instance}/databases/{database} + */ + resourceName?: string; + } + export interface Params$Resource$Databases$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the database in the instance. + */ + database?: string; + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * Name of the resource database. Format: projects/{project}/locations/{location}/instances/{instance}/databases/{database} + */ + resourceName?: string; + } + export interface Params$Resource$Databases$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL should add this database. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Database; + } + export interface Params$Resource$Databases$List 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, which owns this collection of databases. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Databases$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the database to be updated in the instance. + */ + database?: string; + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of the database for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance}/databases/{database} + */ + resourceName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Database; + } + export interface Params$Resource$Databases$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the database to be updated in the instance. + */ + database?: string; + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of the database for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance}/databases/{database} + */ + resourceName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Database; + } + + export class Resource$Flags { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.flags.list + * @desc List all available database flags for Cloud SQL instances. + * @alias sql.flags.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.databaseVersion Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions. + * @param {object} [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$Flags$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Flags$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Flags$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Flags$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Flags$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Flags$List; + 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/flags').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$Flags$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions. + */ + databaseVersion?: string; + } + + export class Resource$Instances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.instances.addServerCa + * @desc Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. + * @alias sql.instances.addServerCa + * @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 should add this server CA. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addServerCa( + params?: Params$Resource$Instances$Addserverca, + options?: MethodOptions + ): GaxiosPromise; + addServerCa( + params: Params$Resource$Instances$Addserverca, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addServerCa( + params: Params$Resource$Instances$Addserverca, + callback: BodyResponseCallback + ): void; + addServerCa(callback: BodyResponseCallback): void; + addServerCa( + paramsOrCallback?: + | Params$Resource$Instances$Addserverca + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Addserverca; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Addserverca; + 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}/addServerCa' + ).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.instances.clone + * @desc Creates a Cloud SQL instance as a clone of the source instance. + * @alias sql.instances.clone + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. + * @param {string=} params.parent The parent resource where Cloud SQL should clone this instance. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the source as well as the clone Cloud SQL instance. + * @param {().InstancesCloneRequest} params.resource Request body data + * @param {object} [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$Instances$Clone, + options?: MethodOptions + ): GaxiosPromise; + clone( + params: Params$Resource$Instances$Clone, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + clone( + params: Params$Resource$Instances$Clone, + callback: BodyResponseCallback + ): void; + clone(callback: BodyResponseCallback): void; + clone( + paramsOrCallback?: + | Params$Resource$Instances$Clone + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Clone; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Clone; + 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}/clone' + ).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.instances.delete + * @desc Deletes a Cloud SQL instance. + * @alias sql.instances.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance to be deleted. + * @param {string=} params.resourceName The name of database instance to delete. Format: projects/{project}/locations/{location}/instances/{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$Instances$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Instances$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instances$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instances$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Delete; + 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}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.instances.demoteMaster + * @desc Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. + * @alias sql.instances.demoteMaster + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance name. + * @param {string=} params.parent The parent resource where Cloud SQL demotes this master database instance. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project ID of the project that contains the instance. + * @param {().InstancesDemoteMasterRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + demoteMaster( + params?: Params$Resource$Instances$Demotemaster, + options?: MethodOptions + ): GaxiosPromise; + demoteMaster( + params: Params$Resource$Instances$Demotemaster, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + demoteMaster( + params: Params$Resource$Instances$Demotemaster, + callback: BodyResponseCallback + ): void; + demoteMaster(callback: BodyResponseCallback): void; + demoteMaster( + paramsOrCallback?: + | Params$Resource$Instances$Demotemaster + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Demotemaster; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Demotemaster; + 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}/demoteMaster' + ).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.instances.export + * @desc Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. + * @alias sql.instances.export + * @memberOf! () + * + * @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 exports this database instance. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance to be exported. + * @param {().InstancesExportRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + export( + params?: Params$Resource$Instances$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Instances$Export, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Instances$Export, + callback: BodyResponseCallback + ): void; + export(callback: BodyResponseCallback): void; + export( + paramsOrCallback?: + | Params$Resource$Instances$Export + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Export; + 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}/export' + ).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.instances.failover + * @desc Failover the instance to its failover replica instance. + * @alias sql.instances.failover + * @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 sends this database instance during a failover. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project ID of the project that contains the read replica. + * @param {().InstancesFailoverRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + failover( + params?: Params$Resource$Instances$Failover, + options?: MethodOptions + ): GaxiosPromise; + failover( + params: Params$Resource$Instances$Failover, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + failover( + params: Params$Resource$Instances$Failover, + callback: BodyResponseCallback + ): void; + failover(callback: BodyResponseCallback): void; + failover( + paramsOrCallback?: + | Params$Resource$Instances$Failover + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Failover; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Failover; + 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}/failover' + ).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.instances.get + * @desc Retrieves a resource containing information about a Cloud SQL instance. + * @alias sql.instances.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName Name of the resource database instance. Format: projects/{project}/locations/{location}/instances/{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 + */ + get( + params?: Params$Resource$Instances$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instances$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instances$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instances$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Get; + 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}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.instances.import + * @desc Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage. + * @alias sql.instances.import + * @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 imports this database instance. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {().InstancesImportRequest} params.resource Request body data + * @param {object} [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$Instances$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Instances$Import, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Instances$Import, + callback: BodyResponseCallback + ): void; + import(callback: BodyResponseCallback): void; + import( + paramsOrCallback?: + | Params$Resource$Instances$Import + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Import; + 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}/import' + ).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.instances.insert + * @desc Creates a new Cloud SQL instance. + * @alias sql.instances.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.parent The parent resource where Cloud SQL creates this database instance. Format: projects/{project}/locations/{location} + * @param {string} params.project Project ID of the project to which the newly created Cloud SQL instances should belong. + * @param {().DatabaseInstance} params.resource Request body data + * @param {object} [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$Instances$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Instances$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instances$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instances$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Insert; + 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' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.instances.list + * @desc Lists instances under a given project in the alphabetical order of the instance name. + * @alias sql.instances.list + * @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 {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.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. + * @return {object} Request object + */ + list( + params?: Params$Resource$Instances$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Instances$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instances$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Instances$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$List; + 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' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.instances.listServerCas + * @desc Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out. + * @alias sql.instances.listServerCas + * @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, which owns this collection of server CAs. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listServerCas( + params?: Params$Resource$Instances$Listservercas, + options?: MethodOptions + ): GaxiosPromise; + listServerCas( + params: Params$Resource$Instances$Listservercas, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listServerCas( + params: Params$Resource$Instances$Listservercas, + callback: BodyResponseCallback + ): void; + listServerCas( + callback: BodyResponseCallback + ): void; + listServerCas( + paramsOrCallback?: + | Params$Resource$Instances$Listservercas + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Listservercas; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Listservercas; + 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}/listServerCas' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * sql.instances.patch + * @desc Updates settings of a Cloud SQL instance. This method supports patch semantics. + * @alias sql.instances.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the database instance for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {().DatabaseInstance} params.resource Request body data + * @param {object} [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$Instances$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Instances$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Instances$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Instances$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Patch; + 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}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.instances.promoteReplica + * @desc Promotes the read replica instance to be a stand-alone Cloud SQL instance. + * @alias sql.instances.promoteReplica + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL read replica instance name. + * @param {string=} params.parent The parent resource where Cloud SQL promotes this replica database instance. Format: projects/{project}/locations/{location} + * @param {string} params.project ID of the project that contains the read replica. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + promoteReplica( + params?: Params$Resource$Instances$Promotereplica, + options?: MethodOptions + ): GaxiosPromise; + promoteReplica( + params: Params$Resource$Instances$Promotereplica, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + promoteReplica( + params: Params$Resource$Instances$Promotereplica, + callback: BodyResponseCallback + ): void; + promoteReplica(callback: BodyResponseCallback): void; + promoteReplica( + paramsOrCallback?: + | Params$Resource$Instances$Promotereplica + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Promotereplica; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Promotereplica; + 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}/promoteReplica' + ).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.instances.resetSslConfig + * @desc Deletes all client certificates and generates a new server SSL certificate for the instance. + * @alias sql.instances.resetSslConfig + * @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 resets this SSL config. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + resetSslConfig( + params?: Params$Resource$Instances$Resetsslconfig, + options?: MethodOptions + ): GaxiosPromise; + resetSslConfig( + params: Params$Resource$Instances$Resetsslconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resetSslConfig( + params: Params$Resource$Instances$Resetsslconfig, + callback: BodyResponseCallback + ): void; + resetSslConfig(callback: BodyResponseCallback): void; + resetSslConfig( + paramsOrCallback?: + | Params$Resource$Instances$Resetsslconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Resetsslconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Resetsslconfig; + 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}/resetSslConfig' + ).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.instances.restart + * @desc Restarts a Cloud SQL instance. + * @alias sql.instances.restart + * @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 restarts this database instance. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance to be restarted. + * @param {object} [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$Instances$Restart, + options?: MethodOptions + ): GaxiosPromise; + restart( + params: Params$Resource$Instances$Restart, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restart( + params: Params$Resource$Instances$Restart, + callback: BodyResponseCallback + ): void; + restart(callback: BodyResponseCallback): void; + restart( + paramsOrCallback?: + | Params$Resource$Instances$Restart + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Restart; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Restart; + 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}/restart' + ).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.instances.restoreBackup + * @desc Restores a backup of a Cloud SQL instance. + * @alias sql.instances.restoreBackup + * @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 restores this database instance from backup. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {().InstancesRestoreBackupRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + restoreBackup( + params?: Params$Resource$Instances$Restorebackup, + options?: MethodOptions + ): GaxiosPromise; + restoreBackup( + params: Params$Resource$Instances$Restorebackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restoreBackup( + params: Params$Resource$Instances$Restorebackup, + callback: BodyResponseCallback + ): void; + restoreBackup(callback: BodyResponseCallback): void; + restoreBackup( + paramsOrCallback?: + | Params$Resource$Instances$Restorebackup + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Restorebackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Restorebackup; + 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}/restoreBackup' + ).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.instances.rotateServerCa + * @desc Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. + * @alias sql.instances.rotateServerCa + * @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 rotates these server CAs. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {().InstancesRotateServerCaRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + rotateServerCa( + params?: Params$Resource$Instances$Rotateserverca, + options?: MethodOptions + ): GaxiosPromise; + rotateServerCa( + params: Params$Resource$Instances$Rotateserverca, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rotateServerCa( + params: Params$Resource$Instances$Rotateserverca, + callback: BodyResponseCallback + ): void; + rotateServerCa(callback: BodyResponseCallback): void; + rotateServerCa( + paramsOrCallback?: + | Params$Resource$Instances$Rotateserverca + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Rotateserverca; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Rotateserverca; + 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}/rotateServerCa' + ).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.instances.startReplica + * @desc Starts the replication in the read replica instance. + * @alias sql.instances.startReplica + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL read replica instance name. + * @param {string=} params.parent The parent resource where Cloud SQL starts this database instance replication. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project ID of the project that contains the read replica. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + startReplica( + params?: Params$Resource$Instances$Startreplica, + options?: MethodOptions + ): GaxiosPromise; + startReplica( + params: Params$Resource$Instances$Startreplica, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startReplica( + params: Params$Resource$Instances$Startreplica, + callback: BodyResponseCallback + ): void; + startReplica(callback: BodyResponseCallback): void; + startReplica( + paramsOrCallback?: + | Params$Resource$Instances$Startreplica + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Startreplica; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Startreplica; + 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}/startReplica' + ).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.instances.stopReplica + * @desc Stops the replication in the read replica instance. + * @alias sql.instances.stopReplica + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL read replica instance name. + * @param {string=} params.parent The parent resource where Cloud SQL stops this database instance replication. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project ID of the project that contains the read replica. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + stopReplica( + params?: Params$Resource$Instances$Stopreplica, + options?: MethodOptions + ): GaxiosPromise; + stopReplica( + params: Params$Resource$Instances$Stopreplica, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopReplica( + params: Params$Resource$Instances$Stopreplica, + callback: BodyResponseCallback + ): void; + stopReplica(callback: BodyResponseCallback): void; + stopReplica( + paramsOrCallback?: + | Params$Resource$Instances$Stopreplica + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Stopreplica; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Stopreplica; + 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}/stopReplica' + ).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.instances.truncateLog + * @desc Truncate MySQL general and slow query log tables + * @alias sql.instances.truncateLog + * @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 truncates this log. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the Cloud SQL project. + * @param {().InstancesTruncateLogRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + truncateLog( + params?: Params$Resource$Instances$Truncatelog, + options?: MethodOptions + ): GaxiosPromise; + truncateLog( + params: Params$Resource$Instances$Truncatelog, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + truncateLog( + params: Params$Resource$Instances$Truncatelog, + callback: BodyResponseCallback + ): void; + truncateLog(callback: BodyResponseCallback): void; + truncateLog( + paramsOrCallback?: + | Params$Resource$Instances$Truncatelog + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Truncatelog; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Truncatelog; + 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}/truncateLog' + ).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.instances.update + * @desc Updates settings of a Cloud SQL instance. + * @alias sql.instances.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the database instance for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {().DatabaseInstance} params.resource Request body data + * @param {object} [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$Instances$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Instances$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Instances$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Instances$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Instances$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Update; + 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}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Instances$Addserverca + 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 should add this server CA. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Instances$Clone extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL should clone this instance. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the source as well as the clone Cloud SQL instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesCloneRequest; + } + export interface Params$Resource$Instances$Delete 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; + /** + * Project ID of the project that contains the instance to be deleted. + */ + project?: string; + /** + * The name of database instance to delete. Format: projects/{project}/locations/{location}/instances/{instance} + */ + resourceName?: string; + } + export interface Params$Resource$Instances$Demotemaster + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL instance name. + */ + instance?: string; + /** + * The parent resource where Cloud SQL demotes this master database instance. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesDemoteMasterRequest; + } + export interface Params$Resource$Instances$Export 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 exports this database instance. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance to be exported. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesExportRequest; + } + export interface Params$Resource$Instances$Failover + 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 sends this database instance during a failover. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * ID of the project that contains the read replica. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesFailoverRequest; + } + export interface Params$Resource$Instances$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * Name of the resource database instance. Format: projects/{project}/locations/{location}/instances/{instance} + */ + resourceName?: string; + } + export interface Params$Resource$Instances$Import 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 imports this database instance. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesImportRequest; + } + export interface Params$Resource$Instances$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The parent resource where Cloud SQL creates this database instance. Format: projects/{project}/locations/{location} + */ + parent?: string; + /** + * Project ID of the project to which the newly created Cloud SQL instances should belong. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DatabaseInstance; + } + export interface Params$Resource$Instances$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * An expression for filtering the results of the request, such as by name or label. + */ + filter?: string; + /** + * The maximum number of results to return per response. + */ + maxResults?: number; + /** + * A previously-returned page token representing part of the larger set of results to view. + */ + pageToken?: string; + /** + * Project ID of the project for which to list Cloud SQL instances. + */ + project?: string; + } + export interface Params$Resource$Instances$Listservercas + 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, which owns this collection of server CAs. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Instances$Patch 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; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of the database instance for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance} + */ + resourceName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DatabaseInstance; + } + export interface Params$Resource$Instances$Promotereplica + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL read replica instance name. + */ + instance?: string; + /** + * The parent resource where Cloud SQL promotes this replica database instance. Format: projects/{project}/locations/{location} + */ + parent?: string; + /** + * ID of the project that contains the read replica. + */ + project?: string; + } + export interface Params$Resource$Instances$Resetsslconfig + 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 resets this SSL config. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Instances$Restart + 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 restarts this database instance. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance to be restarted. + */ + project?: string; + } + export interface Params$Resource$Instances$Restorebackup + 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 restores this database instance from backup. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesRestoreBackupRequest; + } + export interface Params$Resource$Instances$Rotateserverca + 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 rotates these server CAs. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesRotateServerCaRequest; + } + export interface Params$Resource$Instances$Startreplica + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL read replica instance name. + */ + instance?: string; + /** + * The parent resource where Cloud SQL starts this database instance replication. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * ID of the project that contains the read replica. + */ + project?: string; + } + export interface Params$Resource$Instances$Stopreplica + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL read replica instance name. + */ + instance?: string; + /** + * The parent resource where Cloud SQL stops this database instance replication. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * ID of the project that contains the read replica. + */ + project?: string; + } + export interface Params$Resource$Instances$Truncatelog + 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 truncates this log. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the Cloud SQL project. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesTruncateLogRequest; + } + export interface Params$Resource$Instances$Update 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; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of the database instance for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance} + */ + resourceName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DatabaseInstance; + } + + export class Resource$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.operations.get + * @desc Retrieves an instance operation that has been performed on an instance. + * @alias sql.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.operation Instance operation ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/sql/v1beta4/projects/{project}/operations/{operation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'operation'], + pathParams: ['operation', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.operations.list + * @desc Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time. + * @alias sql.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {integer=} params.maxResults Maximum number of operations 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 Indirect parent. The direct parent should combine with the instance name, which owns this collection of operations. Format: projects/{project}/locations/{location} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/sql/v1beta4/projects/{project}/operations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Instance operation ID. + */ + operation?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Operations$List 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; + /** + * Maximum number of operations per response. + */ + maxResults?: number; + /** + * A previously-returned page token representing part of the larger set of results to view. + */ + pageToken?: string; + /** + * Indirect parent. The direct parent should combine with the instance name, which owns this collection of operations. Format: projects/{project}/locations/{location} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + + export class Resource$Sslcerts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.sslCerts.createEphemeral + * @desc Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. + * @alias sql.sslCerts.createEphemeral + * @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 creates this ephemeral certificate. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the Cloud SQL project. + * @param {().SslCertsCreateEphemeralRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createEphemeral( + params?: Params$Resource$Sslcerts$Createephemeral, + options?: MethodOptions + ): GaxiosPromise; + createEphemeral( + params: Params$Resource$Sslcerts$Createephemeral, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createEphemeral( + params: Params$Resource$Sslcerts$Createephemeral, + callback: BodyResponseCallback + ): void; + createEphemeral(callback: BodyResponseCallback): void; + createEphemeral( + paramsOrCallback?: + | Params$Resource$Sslcerts$Createephemeral + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sslcerts$Createephemeral; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcerts$Createephemeral; + 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}/createEphemeral' + ).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.sslCerts.delete + * @desc Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted. + * @alias sql.sslCerts.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of SSL certificate to delete. Format: projects/{project}/locations/{location}/instances/{instance}/sslCerts/{sslCert} + * @param {string} params.sha1Fingerprint Sha1 FingerPrint. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Sslcerts$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Sslcerts$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Sslcerts$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Sslcerts$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sslcerts$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcerts$Delete; + 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}/sslCerts/{sha1Fingerprint}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'sha1Fingerprint'], + pathParams: ['instance', 'project', 'sha1Fingerprint'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.sslCerts.get + * @desc Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation. + * @alias sql.sslCerts.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName Name of the resource ssl certificate. Format: projects/{project}/locations/{location}/instances/{instance}/sslCerts/{sslCert} + * @param {string} params.sha1Fingerprint Sha1 FingerPrint. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Sslcerts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sslcerts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sslcerts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sslcerts$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sslcerts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcerts$Get; + 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}/sslCerts/{sha1Fingerprint}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance', 'sha1Fingerprint'], + pathParams: ['instance', 'project', 'sha1Fingerprint'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.sslCerts.insert + * @desc Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted. + * @alias sql.sslCerts.insert + * @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 creates this SSL certificate. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {().SslCertsInsertRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Sslcerts$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Sslcerts$Insert, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Sslcerts$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Sslcerts$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sslcerts$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcerts$Insert; + 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}/sslCerts' + ).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.sslCerts.list + * @desc Lists all of the current SSL certificates for the instance. + * @alias sql.sslCerts.list + * @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, which owns this collection of SSL certificates. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Sslcerts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Sslcerts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Sslcerts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Sslcerts$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sslcerts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcerts$List; + 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}/sslCerts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sslcerts$Createephemeral + 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 creates this ephemeral certificate. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the Cloud SQL project. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslCertsCreateEphemeralRequest; + } + export interface Params$Resource$Sslcerts$Delete 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; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of SSL certificate to delete. Format: projects/{project}/locations/{location}/instances/{instance}/sslCerts/{sslCert} + */ + resourceName?: string; + /** + * Sha1 FingerPrint. + */ + sha1Fingerprint?: string; + } + export interface Params$Resource$Sslcerts$Get 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; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * Name of the resource ssl certificate. Format: projects/{project}/locations/{location}/instances/{instance}/sslCerts/{sslCert} + */ + resourceName?: string; + /** + * Sha1 FingerPrint. + */ + sha1Fingerprint?: string; + } + export interface Params$Resource$Sslcerts$Insert 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 creates this SSL certificate. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslCertsInsertRequest; + } + export interface Params$Resource$Sslcerts$List 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, which owns this collection of SSL certificates. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + + export class Resource$Tiers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.tiers.list + * @desc Lists all available machine types (tiers) for Cloud SQL, for example, db-n1-standard-1. For related information, see Pricing. + * @alias sql.tiers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID of the project for which to list tiers. + * @param {object} [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$Tiers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Tiers$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Tiers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Tiers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Tiers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tiers$List; + 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}/tiers').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Tiers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID of the project for which to list tiers. + */ + project?: string; + } + + export class Resource$Users { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * sql.users.delete + * @desc Deletes a user from a Cloud SQL instance. + * @alias sql.users.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.host Host of the user in the instance. + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string=} params.name Name of the user in the instance. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/users + * @param {object} [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$Users$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Users$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Users$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Users$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Delete; + 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}/users' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.users.insert + * @desc Creates a new user in a Cloud SQL instance. + * @alias sql.users.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string=} params.parent The parent resource where Cloud SQL creates this user. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {().User} params.resource Request body data + * @param {object} [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$Users$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Users$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Users$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Users$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Insert; + 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}/users' + ).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.users.list + * @desc Lists users in the specified Cloud SQL instance. + * @alias sql.users.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string=} params.parent The parent, which owns this collection of users. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Users$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Users$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Users$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Users$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$List; + 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}/users' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.users.update + * @desc Updates an existing user in a Cloud SQL instance. + * @alias sql.users.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.host Host of the user in the instance. For a MySQL instance, it's required; For a PostgreSQL instance, it's optional. + * @param {string} params.instance Database instance ID. This does not include the project ID. + * @param {string=} params.name Name of the user in the instance. + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.resourceName The name of the user for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance}/users + * @param {().User} params.resource Request body data + * @param {object} [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$Users$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Users$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Users$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Users$Update + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Update; + 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}/users' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Users$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Host of the user in the instance. + */ + host?: string; + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Name of the user in the instance. + */ + name?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of the user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/users + */ + resourceName?: string; + } + export interface Params$Resource$Users$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL creates this user. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$User; + } + export interface Params$Resource$Users$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent, which owns this collection of users. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } + export interface Params$Resource$Users$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Host of the user in the instance. For a MySQL instance, it's required; For a PostgreSQL instance, it's optional. + */ + host?: string; + /** + * Database instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Name of the user in the instance. + */ + name?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * The name of the user for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance}/users + */ + resourceName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$User; + } +} diff --git a/src/apis/sql/webpack.config.js b/src/apis/sql/webpack.config.js new file mode 100644 index 00000000000..9eab47ecc50 --- /dev/null +++ b/src/apis/sql/webpack.config.js @@ -0,0 +1,71 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Sql', + filename: 'sql.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/streetviewpublish/v1.ts b/src/apis/streetviewpublish/v1.ts index 0effaa11345..a5b86620a48 100644 --- a/src/apis/streetviewpublish/v1.ts +++ b/src/apis/streetviewpublish/v1.ts @@ -392,7 +392,7 @@ export namespace streetviewpublish_v1 { */ photo?: Schema$Photo; /** - * Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` <aside class="note"><b>Note:</b> When updateMask contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections are removed.</aside> + * Required. Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` <aside class="note"><b>Note:</b> When updateMask contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections are removed.</aside> */ updateMask?: string | null; } @@ -562,7 +562,7 @@ export namespace streetviewpublish_v1 { * @param {object} params Parameters for request * @param {string=} params.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. * @param {string} params.photoId Required. ID of the Photo. - * @param {string=} params.view Specifies if a download URL for the photo bytes should be returned in the Photo response. + * @param {string=} params.view Required. Specifies if a download URL for the photo bytes should be returned in the Photo 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 @@ -710,7 +710,7 @@ export namespace streetviewpublish_v1 { * * @param {object} params Parameters for request * @param {string} params.id Required. A unique identifier for a photo. - * @param {string=} params.updateMask Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` + * @param {string=} params.updateMask Required. Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` * @param {().Photo} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -811,7 +811,7 @@ export namespace streetviewpublish_v1 { */ photoId?: string; /** - * Specifies if a download URL for the photo bytes should be returned in the Photo response. + * Required. Specifies if a download URL for the photo bytes should be returned in the Photo response. */ view?: string; } @@ -838,7 +838,7 @@ export namespace streetviewpublish_v1 { */ id?: string; /** - * Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` + * Required. Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` */ updateMask?: string; @@ -945,7 +945,7 @@ export namespace streetviewpublish_v1 { * @param {object} params Parameters for request * @param {string=} params.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. * @param {string=} params.photoIds Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`. - * @param {string=} params.view Specifies if a download URL for the photo bytes should be returned in the Photo response. + * @param {string=} params.view Required. Specifies if a download URL for the photo bytes should be returned in the Photo 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 @@ -1105,11 +1105,11 @@ export namespace streetviewpublish_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`. + * @param {string=} params.filter Required. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`. * @param {string=} params.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used. * @param {integer=} params.pageSize The maximum number of photos to return. `pageSize` must be non-negative. If `pageSize` is zero or is not provided, the default page size of 100 is used. The number of photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`. * @param {string=} params.pageToken The nextPageToken value returned from a previous ListPhotos request, if any. - * @param {string=} params.view Specifies if a download URL for the photos bytes should be returned in the Photos response. + * @param {string=} params.view Required. Specifies if a download URL for the photos bytes should be returned in the Photos 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 @@ -1201,7 +1201,7 @@ export namespace streetviewpublish_v1 { */ photoIds?: string[]; /** - * Specifies if a download URL for the photo bytes should be returned in the Photo response. + * Required. Specifies if a download URL for the photo bytes should be returned in the Photo response. */ view?: string; } @@ -1224,7 +1224,7 @@ export namespace streetviewpublish_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`. + * Required. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`. */ filter?: string; /** @@ -1240,7 +1240,7 @@ export namespace streetviewpublish_v1 { */ pageToken?: string; /** - * Specifies if a download URL for the photos bytes should be returned in the Photos response. + * Required. Specifies if a download URL for the photos bytes should be returned in the Photos response. */ view?: string; } diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 377effd9159..2d5bd8b4cc2 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -201,6 +201,10 @@ export namespace testing_v1 { * The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See <https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator> for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator. */ orchestratorOption?: string | null; + /** + * The option to run tests in multiple shards in parallel. + */ + shardingOption?: Schema$ShardingOption; /** * Required. The APK containing the test code to be executed. */ @@ -687,7 +691,7 @@ export namespace testing_v1 { iosDevices?: Schema$IosDevice[]; } /** - * A description of an iOS device tests may be run on. Next tag: 10 + * A description of an iOS device tests may be run on. Next tag: 11 */ export interface Schema$IosModel { /** @@ -740,6 +744,23 @@ export namespace testing_v1 { */ orientations?: Schema$Orientation[]; } + /** + * A test of an iOS application that implements one or more game loop scenarios. This test type accepts an archived application (.ipa file) and a list of integer scenarios that will be executed on the app sequentially. + */ + export interface Schema$IosTestLoop { + /** + * Output only. The bundle id for the application under test. + */ + appBundleId?: string | null; + /** + * Required. The .ipa of the application to test. + */ + appIpa?: Schema$FileReference; + /** + * The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. + */ + scenarios?: number[] | null; + } /** * A description of how to set up an iOS device prior to running the test. */ @@ -820,6 +841,15 @@ export namespace testing_v1 { */ tags?: string[] | null; } + /** + * Shards test cases into the specified groups of packages, classes, and/or methods. With manual sharding enabled, specifying test targets via environment_variables or in InstrumentationTest is invalid. + */ + export interface Schema$ManualSharding { + /** + * Required. Group of packages, classes, and/or test methods to be run for each shard. The number of shard_test_targets must be > 1, and <= 50. + */ + testTargetsForShard?: Schema$TestTargetsForShard[]; + } export interface Schema$NetworkConfiguration { /** * The emulation rule applying to the download traffic. @@ -944,6 +974,36 @@ export namespace testing_v1 { */ timeout?: string | null; } + /** + * Output only. Details about the shard. + */ + export interface Schema$Shard { + /** + * Output only. The total number of shards. + */ + numShards?: number | null; + /** + * Output only. The index of the shard among all the shards. + */ + shardIndex?: number | null; + /** + * Output only. Test targets for each shard. + */ + testTargetsForShard?: Schema$TestTargetsForShard; + } + /** + * Options for enabling sharding. + */ + export interface Schema$ShardingOption { + /** + * Shards test cases into the specified groups of packages, classes, and/or methods. + */ + manualSharding?: Schema$ManualSharding; + /** + * Uniformly shards test cases given a total number of shards. + */ + uniformSharding?: Schema$UniformSharding; + } /** * A starting intent specified by an action, uri, and categories. */ @@ -1015,6 +1075,10 @@ export namespace testing_v1 { * Output only. The cloud project that owns the test execution. */ projectId?: string | null; + /** + * Output only. Details about the shard. + */ + shard?: Schema$Shard; /** * Output only. Indicates the current progress of the test execution (e.g., FINISHED). */ @@ -1142,6 +1206,10 @@ export namespace testing_v1 { * Disables video recording. May reduce test latency. */ disableVideoRecording?: boolean | null; + /** + * An iOS application with a test loop. + */ + iosTestLoop?: Schema$IosTestLoop; /** * Test setup requirements for iOS. */ @@ -1159,6 +1227,15 @@ export namespace testing_v1 { */ testTimeout?: string | null; } + /** + * Test targets for a shard. + */ + export interface Schema$TestTargetsForShard { + /** + * Group of packages, classes, and/or test methods to be run for each shard. The targets need to be specified in AndroidJUnitRunner argument format. For example, “package com.my.packages” “class com.my.package.MyClass”. The number of shard_test_targets must be greater than 0. + */ + testTargets?: string[] | null; + } /** * Represents a tool results execution resource. This has the results of a TestMatrix. */ @@ -1235,6 +1312,15 @@ export namespace testing_v1 { */ packetLossRatio?: number | null; } + /** + * Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to “-e numShard” “-e shardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. + */ + export interface Schema$UniformSharding { + /** + * Required. Total number of shards. The number must be > 1, and <= 50. + */ + numShards?: number | null; + } /** * An Xcode version that an iOS version is compatible with. */ diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index 635ff73f0dc..548a8efe345 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -136,7 +136,7 @@ export namespace texttospeech_v1 { */ pitch?: number | null; /** - * The synthesis sample rate (in hertz) for this audio. Optional. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. + * Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. */ sampleRateHertz?: number | null; /** @@ -222,15 +222,15 @@ export namespace texttospeech_v1 { */ export interface Schema$VoiceSelectionParams { /** - * The language (and optionally also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". Required. This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". + * Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". */ languageCode?: string | null; /** - * The name of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and gender. + * 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. */ name?: string | null; /** - * The preferred gender of the voice. Optional; 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. + * 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 | null; } @@ -344,7 +344,7 @@ export namespace texttospeech_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.languageCode Optional (but recommended) [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. + * @param {string=} params.languageCode Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -415,7 +415,7 @@ export namespace texttospeech_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional (but recommended) [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. + * Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. */ languageCode?: string; } diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 648e0af854d..9e58f84bf82 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -136,7 +136,7 @@ export namespace texttospeech_v1beta1 { */ pitch?: number | null; /** - * The synthesis sample rate (in hertz) for this audio. Optional. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. + * Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT. */ sampleRateHertz?: number | null; /** @@ -222,15 +222,15 @@ export namespace texttospeech_v1beta1 { */ export interface Schema$VoiceSelectionParams { /** - * The language (and optionally also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". Required. This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". + * Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". */ languageCode?: string | null; /** - * The name of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and gender. + * 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. */ name?: string | null; /** - * The preferred gender of the voice. Optional; 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. + * 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 | null; } @@ -344,7 +344,7 @@ export namespace texttospeech_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.languageCode Optional (but recommended) [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. + * @param {string=} params.languageCode Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -415,7 +415,7 @@ export namespace texttospeech_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional (but recommended) [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. + * Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices. */ languageCode?: string; } diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 1bec68621e5..d6a94ab3aa8 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -641,7 +641,7 @@ export namespace toolresults_v1beta3 { */ export interface Schema$PerfSample { /** - * Timestamp of collection + * Timestamp of collection. */ sampleTime?: Schema$Timestamp; /** @@ -802,7 +802,7 @@ export namespace toolresults_v1beta3 { message?: string | null; } /** - * A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 23 + * A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 */ export interface Schema$Step { /** diff --git a/src/apis/translate/v3beta1.ts b/src/apis/translate/v3beta1.ts index ca3bba3dce7..603e76382bf 100644 --- a/src/apis/translate/v3beta1.ts +++ b/src/apis/translate/v3beta1.ts @@ -130,11 +130,11 @@ export namespace translate_v3beta1 { */ 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://goo.gl/xmQnxf for more information on and examples of labels. + * 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/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-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-id}/locations/{location-id}/models/general/nmt`, `projects/{project-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. + * 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; /** @@ -176,7 +176,7 @@ export namespace translate_v3beta1 { */ 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://goo.gl/xmQnxf for more information on and examples of labels. + * 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/labels for more information. */ labels?: {[key: string]: string} | null; /** @@ -184,7 +184,7 @@ export namespace translate_v3beta1 { */ mimeType?: string | null; /** - * Optional. The language detection model to be used. Format: `projects/{project-id}/locations/{location-id}/models/language-detection/{model-id}` Only one language detection model is currently supported: `projects/{project-id}/locations/{location-id}/models/language-detection/default`. If not specified, the default model is used. + * 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; } @@ -244,7 +244,7 @@ export namespace translate_v3beta1 { */ languagePair?: Schema$LanguageCodePair; /** - * Required. The resource name of the glossary. Glossary names have the form `projects/{project-id}/locations/{location-id}/glossaries/{glossary-id}`. + * 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; /** @@ -467,7 +467,7 @@ export namespace translate_v3beta1 { */ 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://goo.gl/xmQnxf for more information on and examples of labels. + * 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/labels for more information. */ labels?: {[key: string]: string} | null; /** @@ -475,7 +475,7 @@ export namespace translate_v3beta1 { */ mimeType?: string | null; /** - * Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-id}/locations/{location-id}/models/general/nmt`, `projects/{project-id}/locations/{location-id}/models/general/base` For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-id}/locations/global/models/general/nmt`. If missing, the system decides which google base model to use. + * 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; /** @@ -510,7 +510,7 @@ export namespace translate_v3beta1 { */ glossaryConfig?: Schema$TranslateTextGlossaryConfig; /** - * Only present when `model` is present in the request. This is same as `model` provided in the request. + * 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; /** @@ -543,7 +543,7 @@ export namespace translate_v3beta1 { * @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-id}/locations/{location-id}` or `projects/{project-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -623,8 +623,8 @@ export namespace translate_v3beta1 { * * @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-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-id}/locations/{location-id}/models/general/nmt`, `projects/{project-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-id}` or `projects/{project-id}/locations/{location-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-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 {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 @@ -700,7 +700,7 @@ export namespace translate_v3beta1 { * @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-id}` or `projects/{project-id}/locations/{location-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-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 {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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -781,7 +781,7 @@ export namespace translate_v3beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-id}/locations/{location-id}` or `projects/{project-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. + * 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; @@ -802,11 +802,11 @@ export namespace translate_v3beta1 { */ displayLanguageCode?: string; /** - * Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-id}/locations/{location-id}/models/general/nmt`, `projects/{project-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. + * 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-id}` or `projects/{project-id}/locations/{location-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-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. + * 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; } @@ -818,7 +818,7 @@ export namespace translate_v3beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-id}` or `projects/{project-id}/locations/{location-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-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. + * 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; @@ -849,7 +849,7 @@ export namespace translate_v3beta1 { * @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-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 {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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -924,7 +924,7 @@ export namespace translate_v3beta1 { * @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-id}/locations/{location-id}` or `projects/{project-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. + * @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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1073,8 +1073,8 @@ export namespace translate_v3beta1 { * * @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-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-id}/locations/{location-id}/models/general/nmt`, `projects/{project-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-id}` or `projects/{project-id}/locations/{location-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-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 {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 @@ -1229,7 +1229,7 @@ export namespace translate_v3beta1 { * @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-id}` or `projects/{project-id}/locations/{location-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-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 {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.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1310,7 +1310,7 @@ export namespace translate_v3beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Location to make a call. Must refer to a caller's project. Format: `projects/{project-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. + * 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; @@ -1327,7 +1327,7 @@ export namespace translate_v3beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-id}/locations/{location-id}` or `projects/{project-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. + * 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; @@ -1360,11 +1360,11 @@ export namespace translate_v3beta1 { */ displayLanguageCode?: string; /** - * Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-id}/locations/{location-id}/models/general/nmt`, `projects/{project-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. + * 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-id}` or `projects/{project-id}/locations/{location-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-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. + * 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; } @@ -1400,7 +1400,7 @@ export namespace translate_v3beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-id}` or `projects/{project-id}/locations/{location-id}`. For global calls, use `projects/{project-id}/locations/global` or `projects/{project-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. + * 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; diff --git a/src/apis/urlshortener/v1.ts b/src/apis/urlshortener/v1.ts deleted file mode 100644 index ec16ee1c38b..00000000000 --- a/src/apis/urlshortener/v1.ts +++ /dev/null @@ -1,476 +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 urlshortener_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; - } - - /** - * URL Shortener API - * - * Lets you create, inspect, and manage goo.gl short URLs - * - * @example - * const {google} = require('googleapis'); - * const urlshortener = google.urlshortener('v1'); - * - * @namespace urlshortener - * @type {Function} - * @version v1 - * @variation v1 - * @param {object=} options Options for Urlshortener - */ - export class Urlshortener { - context: APIRequestContext; - url: Resource$Url; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.url = new Resource$Url(this.context); - } - } - - export interface Schema$AnalyticsSnapshot { - /** - * Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available. - */ - browsers?: Schema$StringCount[]; - /** - * Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available. - */ - countries?: Schema$StringCount[]; - /** - * Number of clicks on all goo.gl short URLs pointing to this long URL. - */ - longUrlClicks?: string | null; - /** - * Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available. - */ - platforms?: Schema$StringCount[]; - /** - * Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available. - */ - referrers?: Schema$StringCount[]; - /** - * Number of clicks on this short URL. - */ - shortUrlClicks?: string | null; - } - export interface Schema$AnalyticsSummary { - /** - * Click analytics over all time. - */ - allTime?: Schema$AnalyticsSnapshot; - /** - * Click analytics over the last day. - */ - day?: Schema$AnalyticsSnapshot; - /** - * Click analytics over the last month. - */ - month?: Schema$AnalyticsSnapshot; - /** - * Click analytics over the last two hours. - */ - twoHours?: Schema$AnalyticsSnapshot; - /** - * Click analytics over the last week. - */ - week?: Schema$AnalyticsSnapshot; - } - export interface Schema$StringCount { - /** - * Number of clicks for this top entry, e.g. for this particular country or browser. - */ - count?: string | null; - /** - * Label assigned to this top entry, e.g. "US" or "Chrome". - */ - id?: string | null; - } - export interface Schema$Url { - /** - * A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable. - */ - analytics?: Schema$AnalyticsSummary; - /** - * Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00". - */ - created?: string | null; - /** - * Short URL, e.g. "http://goo.gl/l6MS". - */ - id?: string | null; - /** - * The fixed string "urlshortener#url". - */ - kind?: string | null; - /** - * Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED". - */ - longUrl?: string | null; - /** - * Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example. - */ - status?: string | null; - } - export interface Schema$UrlHistory { - /** - * A list of URL resources. - */ - items?: Schema$Url[]; - /** - * Number of items returned with each full "page" of results. Note that the last page could have fewer items than the "itemsPerPage" value. - */ - itemsPerPage?: number | null; - /** - * The fixed string "urlshortener#urlHistory". - */ - kind?: string | null; - /** - * A token to provide to get the next page of results. - */ - nextPageToken?: string | null; - /** - * Total number of short URLs associated with this user (may be approximate). - */ - totalItems?: number | null; - } - - export class Resource$Url { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * urlshortener.url.get - * @desc Expands a short URL or gets creation time and analytics. - * @alias urlshortener.url.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.projection Additional information to return. - * @param {string} params.shortUrl The short URL, including the protocol. - * @param {object} [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$Url$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Url$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Url$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Url$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Url$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Url$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/urlshortener/v1/url').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['shortUrl'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * urlshortener.url.insert - * @desc Creates a new short URL. - * @alias urlshortener.url.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().Url} params.resource Request body data - * @param {object} [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$Url$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Url$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Url$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Url$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Url$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Url$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/urlshortener/v1/url').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * urlshortener.url.list - * @desc Retrieves a list of URLs shortened by a user. - * @alias urlshortener.url.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {string=} params.projection Additional information to return. - * @param {string=} params.start-token Token for requesting successive pages of results. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Url$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Url$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Url$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Url$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Url$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Url$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/urlshortener/v1/url/history').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$Url$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Additional information to return. - */ - projection?: string; - /** - * The short URL, including the protocol. - */ - shortUrl?: string; - } - export interface Params$Resource$Url$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Request body metadata - */ - requestBody?: Schema$Url; - } - export interface Params$Resource$Url$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Additional information to return. - */ - projection?: string; - /** - * Token for requesting successive pages of results. - */ - 'start-token'?: string; - } -} diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index e5a93853ce5..bd54bf66b76 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -106,6 +106,7 @@ export namespace vault_v1 { export class Vault { context: APIRequestContext; matters: Resource$Matters; + operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -114,6 +115,7 @@ export namespace vault_v1 { }; this.matters = new Resource$Matters(this.context); + this.operations = new Resource$Operations(this.context); } } @@ -3457,4 +3459,93 @@ export namespace vault_v1 { */ pageToken?: string; } + + export class Resource$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * vault.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 vault.operations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be deleted. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vault.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } } diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 15b76080ae3..f92772e46e9 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -441,7 +441,7 @@ export namespace videointelligence_v1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -453,7 +453,7 @@ export namespace videointelligence_v1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -823,7 +823,7 @@ export namespace videointelligence_v1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -835,7 +835,7 @@ export namespace videointelligence_v1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1205,7 +1205,7 @@ export namespace videointelligence_v1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1217,7 +1217,7 @@ export namespace videointelligence_v1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1598,7 +1598,7 @@ export namespace videointelligence_v1 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + * For tracking related features. An object at time_offset with attributes, and located with normalized_bounding_box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { /** @@ -1701,7 +1701,7 @@ export namespace videointelligence_v1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1713,7 +1713,7 @@ export namespace videointelligence_v1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1777,7 +1777,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoRequest { /** - * Requested video annotation features. + * Required. Requested video annotation features. */ features?: string[] | null; /** @@ -1789,11 +1789,11 @@ export namespace videointelligence_v1 { */ inputUri?: string | null; /** - * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string | null; /** - * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string | null; /** @@ -2034,7 +2034,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechContext { /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). + * Optional. A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[] | null; } @@ -2073,39 +2073,39 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. + * Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[] | null; /** - * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. + * Optional. If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number | null; /** - * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." + * Optional. If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean | null; /** - * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** - * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. + * Optional. If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean | null; /** - * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. + * Optional. If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean | null; /** - * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. + * Required. *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string | null; /** - * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. + * Optional. Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number | null; /** - * *Optional* A means to provide context to assist the speech recognition. + * Optional. A means to provide context to assist the speech recognition. */ speechContexts?: Schema$GoogleCloudVideointelligenceV1_SpeechContext[]; } @@ -2227,7 +2227,7 @@ export namespace videointelligence_v1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2239,7 +2239,7 @@ export namespace videointelligence_v1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index e2f4e7a8de9..a3f24dfbd8c 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -131,7 +131,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoRequest { /** - * Requested video annotation features. + * Required. Requested video annotation features. */ features?: string[] | null; /** @@ -143,11 +143,11 @@ export namespace videointelligence_v1beta2 { */ inputUri?: string | null; /** - * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string | null; /** - * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string | null; /** @@ -388,7 +388,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechContext { /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). + * Optional. A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[] | null; } @@ -427,39 +427,39 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. + * Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[] | null; /** - * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. + * Optional. If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number | null; /** - * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." + * Optional. If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean | null; /** - * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** - * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. + * Optional. If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean | null; /** - * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. + * Optional. If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean | null; /** - * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. + * Required. *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string | null; /** - * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. + * Optional. Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number | null; /** - * *Optional* A means to provide context to assist the speech recognition. + * Optional. A means to provide context to assist the speech recognition. */ speechContexts?: Schema$GoogleCloudVideointelligenceV1beta2_SpeechContext[]; } @@ -581,7 +581,7 @@ export namespace videointelligence_v1beta2 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -593,7 +593,7 @@ export namespace videointelligence_v1beta2 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -996,7 +996,7 @@ export namespace videointelligence_v1beta2 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1008,7 +1008,7 @@ export namespace videointelligence_v1beta2 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1378,7 +1378,7 @@ export namespace videointelligence_v1beta2 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1390,7 +1390,7 @@ export namespace videointelligence_v1beta2 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1771,7 +1771,7 @@ export namespace videointelligence_v1beta2 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + * For tracking related features. An object at time_offset with attributes, and located with normalized_bounding_box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { /** @@ -1874,7 +1874,7 @@ export namespace videointelligence_v1beta2 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1886,7 +1886,7 @@ export namespace videointelligence_v1beta2 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2256,7 +2256,7 @@ export namespace videointelligence_v1beta2 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2268,7 +2268,7 @@ export namespace videointelligence_v1beta2 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/videointelligence/v1p1beta1.ts b/src/apis/videointelligence/v1p1beta1.ts index 198a10336bf..8f437e6c869 100644 --- a/src/apis/videointelligence/v1p1beta1.ts +++ b/src/apis/videointelligence/v1p1beta1.ts @@ -437,7 +437,7 @@ export namespace videointelligence_v1p1beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -449,7 +449,7 @@ export namespace videointelligence_v1p1beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -513,7 +513,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoRequest { /** - * Requested video annotation features. + * Required. Requested video annotation features. */ features?: string[] | null; /** @@ -525,11 +525,11 @@ export namespace videointelligence_v1p1beta1 { */ inputUri?: string | null; /** - * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string | null; /** - * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string | null; /** @@ -770,7 +770,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechContext { /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). + * Optional. A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[] | null; } @@ -809,39 +809,39 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. + * Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[] | null; /** - * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. + * Optional. If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number | null; /** - * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." + * Optional. If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean | null; /** - * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** - * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. + * Optional. If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean | null; /** - * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. + * Optional. If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean | null; /** - * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. + * Required. *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string | null; /** - * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. + * Optional. Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number | null; /** - * *Optional* A means to provide context to assist the speech recognition. + * Optional. A means to provide context to assist the speech recognition. */ speechContexts?: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechContext[]; } @@ -963,7 +963,7 @@ export namespace videointelligence_v1p1beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -975,7 +975,7 @@ export namespace videointelligence_v1p1beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1378,7 +1378,7 @@ export namespace videointelligence_v1p1beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1390,7 +1390,7 @@ export namespace videointelligence_v1p1beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1771,7 +1771,7 @@ export namespace videointelligence_v1p1beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + * For tracking related features. An object at time_offset with attributes, and located with normalized_bounding_box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { /** @@ -1874,7 +1874,7 @@ export namespace videointelligence_v1p1beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1886,7 +1886,7 @@ export namespace videointelligence_v1p1beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2256,7 +2256,7 @@ export namespace videointelligence_v1p1beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2268,7 +2268,7 @@ export namespace videointelligence_v1p1beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/videointelligence/v1p2beta1.ts b/src/apis/videointelligence/v1p2beta1.ts index b4b1d091826..cbf89d1e50f 100644 --- a/src/apis/videointelligence/v1p2beta1.ts +++ b/src/apis/videointelligence/v1p2beta1.ts @@ -437,7 +437,7 @@ export namespace videointelligence_v1p2beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -449,7 +449,7 @@ export namespace videointelligence_v1p2beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -819,7 +819,7 @@ export namespace videointelligence_v1p2beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -831,7 +831,7 @@ export namespace videointelligence_v1p2beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -895,7 +895,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoRequest { /** - * Requested video annotation features. + * Required. Requested video annotation features. */ features?: string[] | null; /** @@ -907,11 +907,11 @@ export namespace videointelligence_v1p2beta1 { */ inputUri?: string | null; /** - * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string | null; /** - * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string | null; /** @@ -1152,7 +1152,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechContext { /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). + * Optional. A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[] | null; } @@ -1191,39 +1191,39 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. + * Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[] | null; /** - * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. + * Optional. If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number | null; /** - * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." + * Optional. If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean | null; /** - * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** - * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. + * Optional. If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean | null; /** - * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. + * Optional. If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean | null; /** - * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. + * Required. *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string | null; /** - * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. + * Optional. Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number | null; /** - * *Optional* A means to provide context to assist the speech recognition. + * Optional. A means to provide context to assist the speech recognition. */ speechContexts?: Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechContext[]; } @@ -1345,7 +1345,7 @@ export namespace videointelligence_v1p2beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1357,7 +1357,7 @@ export namespace videointelligence_v1p2beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1771,7 +1771,7 @@ export namespace videointelligence_v1p2beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + * For tracking related features. An object at time_offset with attributes, and located with normalized_bounding_box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { /** @@ -1874,7 +1874,7 @@ export namespace videointelligence_v1p2beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1886,7 +1886,7 @@ export namespace videointelligence_v1p2beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2256,7 +2256,7 @@ export namespace videointelligence_v1p2beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2268,7 +2268,7 @@ export namespace videointelligence_v1p2beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/videointelligence/v1p3beta1.ts b/src/apis/videointelligence/v1p3beta1.ts index 0cb6c85ab6d..e4b606d6c53 100644 --- a/src/apis/videointelligence/v1p3beta1.ts +++ b/src/apis/videointelligence/v1p3beta1.ts @@ -437,7 +437,7 @@ export namespace videointelligence_v1p3beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -449,7 +449,7 @@ export namespace videointelligence_v1p3beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -819,7 +819,7 @@ export namespace videointelligence_v1p3beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -831,7 +831,7 @@ export namespace videointelligence_v1p3beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1201,7 +1201,7 @@ export namespace videointelligence_v1p3beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1213,7 +1213,7 @@ export namespace videointelligence_v1p3beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1277,7 +1277,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoRequest { /** - * Requested video annotation features. + * Required. Requested video annotation features. */ features?: string[] | null; /** @@ -1289,11 +1289,11 @@ export namespace videointelligence_v1p3beta1 { */ inputUri?: string | null; /** - * Optional cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. */ locationId?: string | null; /** - * Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](/storage/docs/reference-uris). */ outputUri?: string | null; /** @@ -1568,7 +1568,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechContext { /** - * *Optional* A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). + * Optional. A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech/limits#content). */ phrases?: string[] | null; } @@ -1607,39 +1607,39 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechTranscriptionConfig { /** - * *Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. + * Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. */ audioTracks?: number[] | null; /** - * *Optional* If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. + * Optional. If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. */ diarizationSpeakerCount?: number | null; /** - * *Optional* If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." + * Optional. If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." */ enableAutomaticPunctuation?: boolean | null; /** - * *Optional* If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** - * *Optional* If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. + * Optional. If `true`, the top result includes a list of words and the confidence for those words. If `false`, no word-level confidence information is returned. The default is `false`. */ enableWordConfidence?: boolean | null; /** - * *Optional* If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. + * Optional. If set to `true`, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to `false` or omitted, profanities won't be filtered out. */ filterProfanity?: boolean | null; /** - * *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. + * Required. *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes. */ languageCode?: string | null; /** - * *Optional* Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. + * Optional. Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of `SpeechRecognitionAlternative` messages within each `SpeechTranscription`. The server may return fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of one. If omitted, will return a maximum of one. */ maxAlternatives?: number | null; /** - * *Optional* A means to provide context to assist the speech recognition. + * Optional. A means to provide context to assist the speech recognition. */ speechContexts?: Schema$GoogleCloudVideointelligenceV1p3beta1_SpeechContext[]; } @@ -1738,7 +1738,7 @@ export namespace videointelligence_v1p3beta1 { segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; } /** - * For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box. + * For tracking related features. An object at time_offset with attributes, and located with normalized_bounding_box. */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_TimestampedObject { /** @@ -1841,7 +1841,7 @@ export namespace videointelligence_v1p3beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -1853,7 +1853,7 @@ export namespace videointelligence_v1p3beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2256,7 +2256,7 @@ export namespace videointelligence_v1p3beta1 { */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** @@ -2268,7 +2268,7 @@ export namespace videointelligence_v1p3beta1 { */ shotLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on shot level. There is exactly one element for each unique label. + * Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical `shot_label_annotations`, this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ shotPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 7bcd92e3c3b..901cf5b1b0e 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -130,7 +130,7 @@ export namespace vision_v1 { */ export interface Schema$AddProductToProductSetRequest { /** - * The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ product?: string | null; } @@ -293,7 +293,7 @@ export namespace vision_v1 { */ parent?: string | null; /** - * Individual async file annotation requests for this batch. + * Required. Individual async file annotation requests for this batch. */ requests?: Schema$AsyncAnnotateFileRequest[]; } @@ -319,7 +319,7 @@ export namespace vision_v1 { */ parent?: string | null; /** - * Individual image annotation requests for this batch. + * Required. Individual image annotation requests for this batch. */ requests?: Schema$AnnotateImageRequest[]; } @@ -341,7 +341,7 @@ export namespace vision_v1 { */ parent?: string | null; /** - * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. + * Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. */ requests?: Schema$AnnotateFileRequest[]; } @@ -363,7 +363,7 @@ export namespace vision_v1 { */ parent?: string | null; /** - * Individual image annotation requests for this batch. + * Required. Individual image annotation requests for this batch. */ requests?: Schema$AnnotateImageRequest[]; } @@ -1211,7 +1211,7 @@ export namespace vision_v1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -2073,7 +2073,7 @@ export namespace vision_v1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -2965,7 +2965,7 @@ export namespace vision_v1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -3080,7 +3080,7 @@ export namespace vision_v1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** @@ -3088,7 +3088,7 @@ export namespace vision_v1 { */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -3370,1064 +3370,79 @@ export namespace vision_v1 { * If present, image properties were extracted successfully. */ imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p4beta1ImageProperties; - /** - * If present, image quality calculation has completed successfully. - */ - imageQualityAnnotation?: Schema$GoogleCloudVisionV1p4beta1ImageQuality; - /** - * If present, label detection has completed successfully. - */ - labelAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, landmark detection has completed successfully. - */ - landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. - */ - localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; - /** - * If present, logo detection has completed successfully. - */ - logoAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, product search has completed successfully. - */ - productSearchResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResults; - /** - * If present, image quality optimization has completed successfully. - */ - qualityOptimizationResult?: Schema$GoogleCloudVisionV1p4beta1QualityOptimizationResult; - /** - * If present, safe-search annotation has completed successfully. - */ - safeSearchAnnotation?: Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation; - /** - * If present, text (OCR) detection has completed successfully. - */ - textAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, web detection has completed successfully. - */ - webDetection?: Schema$GoogleCloudVisionV1p4beta1WebDetection; - } - /** - * The response for a single offline file annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse { - /** - * The output location and metadata from AsyncAnnotateFileRequest. - */ - outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; - } - /** - * Response to an async batch file annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { - /** - * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. - */ - responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; - } - /** - * Response to an async batch image annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse { - /** - * The output location and metadata from AsyncBatchAnnotateImagesRequest. - */ - outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; - } - /** - * A list of file annotation responses. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { - /** - * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. - */ - responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; - } - /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { - /** - * The time when the batch request is finished and google.longrunning.Operation.done is set to true. - */ - endTime?: string | null; - /** - * The current state of the batch operation. - */ - state?: string | null; - /** - * The time when the batch request was submitted to the server. - */ - submitTime?: string | null; - } - /** - * Logical element on the page. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Block { - /** - * Detected block type (text, image etc) for this block. - */ - blockType?: string | null; - /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results on the block. Range [0, 1]. - */ - confidence?: number | null; - /** - * List of paragraphs in this block (if this blocks is of type text). - */ - paragraphs?: Schema$GoogleCloudVisionV1p4beta1Paragraph[]; - /** - * Additional information detected for the block. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BoundingPoly { - /** - * The bounding polygon normalized vertices. - */ - normalizedVertices?: Schema$GoogleCloudVisionV1p4beta1NormalizedVertex[]; - /** - * The bounding polygon vertices. - */ - vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; - } - /** - * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { - /** - * RGB components of the color. - */ - color?: Schema$Color; - /** - * The fraction of pixels the color occupies in the image. Value in range [0, 1]. - */ - pixelFraction?: number | null; - /** - * Image-specific score for this color. Value in range [0, 1]. - */ - score?: number | null; - } - /** - * Single crop hint that is used to generate a new crop when serving an image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1CropHint { - /** - * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of this being a salient region. Range [0, 1]. - */ - confidence?: number | null; - /** - * Fraction of importance of this salient region with respect to the original image. - */ - importanceFraction?: number | null; - } - /** - * Set of crop hints that are used to generate new crops when serving images. - */ - export interface Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation { - /** - * Crop hint results. - */ - cropHints?: Schema$GoogleCloudVisionV1p4beta1CropHint[]; - } - /** - * Set of dominant colors and their corresponding scores. - */ - export interface Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation { - /** - * RGB color values with their score and pixel fraction. - */ - colors?: Schema$GoogleCloudVisionV1p4beta1ColorInfo[]; - } - /** - * Set of detected entity features. - */ - export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { - /** - * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. - */ - confidence?: number | null; - /** - * Entity textual description, expressed in its `locale` language. - */ - description?: string | null; - /** - * The language code for the locale in which the entity textual `description` is expressed. - */ - locale?: string | null; - /** - * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. - */ - locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; - /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). - */ - mid?: string | null; - /** - * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. - */ - properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; - /** - * Overall score of the result. Range [0, 1]. - */ - score?: number | null; - /** - * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. - */ - topicality?: number | null; - } - /** - * A face annotation object contains the results of face detection. - */ - export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotation { - /** - * Anger likelihood. - */ - angerLikelihood?: string | null; - /** - * Blurred likelihood. - */ - blurredLikelihood?: string | null; - /** - * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Detection confidence. Range [0, 1]. - */ - detectionConfidence?: number | null; - /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. - */ - fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Headwear likelihood. - */ - headwearLikelihood?: string | null; - /** - * Joy likelihood. - */ - joyLikelihood?: string | null; - /** - * Face landmarking confidence. Range [0, 1]. - */ - landmarkingConfidence?: number | null; - /** - * Detected face landmarks. - */ - landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; - /** - * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. - */ - panAngle?: number | null; - /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. - */ - rollAngle?: number | null; - /** - * Sorrow likelihood. - */ - sorrowLikelihood?: string | null; - /** - * Surprise likelihood. - */ - surpriseLikelihood?: string | null; - /** - * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. - */ - tiltAngle?: number | null; - /** - * Under-exposed likelihood. - */ - underExposedLikelihood?: string | null; - } - /** - * A face-specific landmark (for example, a face feature). - */ - export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { - /** - * Face landmark position. - */ - position?: Schema$GoogleCloudVisionV1p4beta1Position; - /** - * Face landmark type. - */ - type?: string | null; - } - /** - * The Google Cloud Storage location where the output will be written to. - */ - export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { - /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. - */ - uri?: string | null; - } - /** - * The Google Cloud Storage location where the input will be read from. - */ - export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { - /** - * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. - */ - uri?: string | null; - } - /** - * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { - /** - * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. - */ - pageNumber?: number | null; - /** - * The URI of the file used to produce the image. - */ - uri?: string | null; - } - /** - * Stores image properties, such as dominant colors. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageProperties { - /** - * If present, dominant colors completed successfully. - */ - dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; - } - /** - * Stores image quality scores, could be aesthetic quality or technical quality. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageQuality { - /** - * A score representing the aesthetic/technical quality of the image. The score is in range [0, 1]. Higher value corresponds to more professional looking photos. 0 means the image looks very bad, 1 means the image with very high quality. - */ - qualityScore?: number | null; - } - /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { - /** - * The list of reference_images that are imported successfully. - */ - referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; - /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. - */ - statuses?: Schema$Status[]; - } - /** - * The desired input location and metadata. - */ - export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { - /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. - */ - content?: string | null; - /** - * The Google Cloud Storage location to read the input from. - */ - gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; - /** - * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. - */ - mimeType?: string | null; - } - /** - * Set of detected objects with bounding boxes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation { - /** - * Image region to which this object belongs. This must be populated. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - /** - * Object ID that should align with EntityAnnotation mid. - */ - mid?: string | null; - /** - * Object name, expressed in its `language_code` language. - */ - name?: string | null; - /** - * Score of the result. Range [0, 1]. - */ - score?: number | null; - } - /** - * Detected entity location information. - */ - export interface Schema$GoogleCloudVisionV1p4beta1LocationInfo { - /** - * lat/long location coordinates. - */ - latLng?: Schema$LatLng; - } - /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. - */ - export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - } - /** - * Contains metadata for the BatchAnnotateImages operation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1OperationMetadata { - /** - * The time when the batch request was received. - */ - createTime?: string | null; - /** - * Current state of the batch operation. - */ - state?: string | null; - /** - * The time when the operation result was last updated. - */ - updateTime?: string | null; - } - /** - * The desired output location and metadata. - */ - export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { - /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. - */ - batchSize?: number | null; - /** - * The Google Cloud Storage location to write the output(s) to. - */ - gcsDestination?: Schema$GoogleCloudVisionV1p4beta1GcsDestination; - } - /** - * Detected page from OCR. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Page { - /** - * List of blocks of text, images etc on this page. - */ - blocks?: Schema$GoogleCloudVisionV1p4beta1Block[]; - /** - * Confidence of the OCR results on the page. Range [0, 1]. - */ - confidence?: number | null; - /** - * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. - */ - height?: number | null; - /** - * Additional information detected on the page. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. - */ - width?: number | null; - } - /** - * Structural unit of text representing a number of words in certain order. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { - /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the paragraph. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the paragraph. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * List of all words in this paragraph. - */ - words?: Schema$GoogleCloudVisionV1p4beta1Word[]; - } - /** - * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Position { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - /** - * Z coordinate (or depth). - */ - z?: number | null; - } - /** - * A Product contains ReferenceImages. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Product { - /** - * User-provided metadata to be stored with this product. Must be at most 4096 characters long. - */ - description?: string | null; - /** - * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. - */ - displayName?: string | null; - /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. - */ - name?: string | null; - /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. - */ - productCategory?: string | null; - /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. - */ - productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; - } - /** - * A product label represented as a key-value pair. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { - /** - * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. - */ - key?: string | null; - /** - * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. - */ - value?: string | null; - } - /** - * Results for a product search request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { - /** - * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. - */ - indexTime?: string | null; - /** - * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. - */ - productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; - /** - * List of results, one for each product match. - */ - results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; - } - /** - * Information about the products similar to a single product in a query image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { - /** - * The bounding polygon around the product detected in the query image. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * List of generic predictions for the object in the bounding box. - */ - objectAnnotations?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation[]; - /** - * List of results, one for each product match. - */ - results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; - } - /** - * Prediction for what the object in the bounding box is. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation { - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - /** - * Object ID that should align with EntityAnnotation mid. - */ - mid?: string | null; - /** - * Object name, expressed in its `language_code` language. - */ - name?: string | null; - /** - * Score of the result. Range [0, 1]. - */ - score?: number | null; - } - /** - * Information about a product. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { - /** - * The resource name of the image from the product that is the closest match to the query. - */ - image?: string | null; - /** - * The Product. - */ - product?: Schema$GoogleCloudVisionV1p4beta1Product; - /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). - */ - score?: number | null; - } - /** - * A `Property` consists of a user-supplied name/value pair. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Property { - /** - * Name of the property. - */ - name?: string | null; - /** - * Value of numeric properties. - */ - uint64Value?: string | null; - /** - * Value of the property. - */ - value?: string | null; - } - /** - * Stores enhanced image bytes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1QualityOptimizationResult { - /** - * Optimized image bytes. - */ - image?: string | null; - /** - * Mime type of the output image. - */ - mimeType?: string | null; - /** - * Required optimization type. - */ - qualityOptimizationType?: string | null; - } - /** - * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { - /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). - */ - boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; - /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. - */ - name?: string | null; - /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. - */ - uri?: string | null; - } - /** - * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). - */ - export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { - /** - * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. - */ - adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; - /** - * Likelihood that this is a medical image. - */ - medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; - /** - * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. - */ - racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; - /** - * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. - */ - spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; - /** - * Likelihood that this image contains violent content. - */ - violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | null; - } - /** - * A single symbol representation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Symbol { - /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the symbol. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the symbol. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * The actual UTF-8 representation of the symbol. - */ - text?: string | null; - } - /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { - /** - * List of pages detected by OCR. - */ - pages?: Schema$GoogleCloudVisionV1p4beta1Page[]; - /** - * UTF-8 text detected on the pages. - */ - text?: string | null; - } - /** - * Detected start or end of a structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak { - /** - * True if break prepends the element. - */ - isPrefix?: boolean | null; - /** - * Detected break type. - */ - type?: string | null; - } - /** - * Detected language for a structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage { - /** - * Confidence of detected language. Range [0, 1]. - */ - confidence?: number | null; - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - } - /** - * Additional information detected on the structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty { - /** - * Detected start or end of a text segment. - */ - detectedBreak?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; - } - /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Vertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - } - /** - * Relevant information for the image from the Internet. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { - /** - * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. - */ - bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; - /** - * Fully matching images from the Internet. Can include resized copies of the query image. - */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Web pages containing the matching images from the Internet. - */ - pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; - /** - * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. - */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * The visually similar image results. - */ - visuallySimilarImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Deduced entities from similar images on the Internet. - */ - webEntities?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity[]; - } - /** - * Entity deduced from similar images on the Internet. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity { - /** - * Canonical description of the entity, in English. - */ - description?: string | null; - /** - * Opaque entity ID. - */ - entityId?: string | null; - /** - * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. - */ - score?: number | null; - } - /** - * Metadata for online images. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage { - /** - * (Deprecated) Overall relevancy score for the image. - */ - score?: number | null; - /** - * The result image URL. - */ - url?: string | null; - } - /** - * Label to provide extra metadata for the web detection. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel { - /** - * Label for extra metadata. - */ - label?: string | null; - /** - * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - } - /** - * Metadata for web pages. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { - /** - * Fully matching images on the page. Can include resized copies of the query image. - */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Title for the web page, may contain HTML markups. - */ - pageTitle?: string | null; - /** - * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. - */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * (Deprecated) Overall relevancy score for the web page. - */ - score?: number | null; - /** - * The result web page URL. - */ - url?: string | null; - } - /** - * A word representation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Word { - /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the word. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the word. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * List of symbols in the word. The order of the symbols follows the natural reading order. - */ - symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; - } - /** - * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. - */ - export interface Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse { - /** - * If set, represents the error message for the failed request. The `responses` field will not be set in this case. - */ - error?: Schema$Status; - /** - * Information about the file for which this response is generated. - */ - inputConfig?: Schema$GoogleCloudVisionV1p5beta1InputConfig; - /** - * Individual responses to images found within the file. This field will be empty if the `error` field is set. - */ - responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse[]; - /** - * This field gives the total number of pages in the file. - */ - totalPages?: number | null; - } - /** - * Response to an image annotation request. - */ - export interface Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse { - /** - * If present, contextual information is needed to understand where this image comes from. - */ - context?: Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext; - /** - * If present, crop hints have completed successfully. - */ - cropHintsAnnotation?: Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation; - /** - * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. - */ - error?: Schema$Status; - /** - * If present, face detection has completed successfully. - */ - faceAnnotations?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotation[]; - /** - * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. - */ - fullTextAnnotation?: Schema$GoogleCloudVisionV1p5beta1TextAnnotation; - /** - * If present, image properties were extracted successfully. - */ - imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p5beta1ImageProperties; /** * If present, label detection has completed successfully. */ - labelAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + labelAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, landmark detection has completed successfully. */ - landmarkAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ - localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation[]; + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; /** * If present, logo detection has completed successfully. */ - logoAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + logoAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, product search has completed successfully. */ - productSearchResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResults; + productSearchResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ - safeSearchAnnotation?: Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation; + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation; /** * If present, text (OCR) detection has completed successfully. */ - textAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + textAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, web detection has completed successfully. */ - webDetection?: Schema$GoogleCloudVisionV1p5beta1WebDetection; + webDetection?: Schema$GoogleCloudVisionV1p4beta1WebDetection; } /** * The response for a single offline file annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse { /** * The output location and metadata from AsyncAnnotateFileRequest. */ - outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; + outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; } /** * Response to an async batch file annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateFilesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { /** * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ - responses?: Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse[]; + responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; } /** * Response to an async batch image annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateImagesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse { /** * The output location and metadata from AsyncBatchAnnotateImagesRequest. */ - outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; + outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; } /** * A list of file annotation responses. */ - export interface Schema$GoogleCloudVisionV1p5beta1BatchAnnotateFilesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { /** * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ - responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse[]; + responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ - export interface Schema$GoogleCloudVisionV1p5beta1BatchOperationMetadata { + export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ @@ -4444,7 +3459,7 @@ export namespace vision_v1 { /** * Logical element on the page. */ - export interface Schema$GoogleCloudVisionV1p5beta1Block { + export interface Schema$GoogleCloudVisionV1p4beta1Block { /** * Detected block type (text, image etc) for this block. */ @@ -4452,49 +3467,37 @@ export namespace vision_v1 { /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results on the block. Range [0, 1]. */ confidence?: number | null; - /** - * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. - */ - keyValuePair?: Schema$GoogleCloudVisionV1p5beta1KeyValuePair; - /** - * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. - */ - mergedText?: string | null; /** * List of paragraphs in this block (if this blocks is of type text). */ - paragraphs?: Schema$GoogleCloudVisionV1p5beta1Paragraph[]; + paragraphs?: Schema$GoogleCloudVisionV1p4beta1Paragraph[]; /** * Additional information detected for the block. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; - /** - * Detected table for TABLE block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. - */ - table?: Schema$GoogleCloudVisionV1p5beta1Table; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; } /** * A bounding polygon for the detected image annotation. */ - export interface Schema$GoogleCloudVisionV1p5beta1BoundingPoly { + export interface Schema$GoogleCloudVisionV1p4beta1BoundingPoly { /** * The bounding polygon normalized vertices. */ - normalizedVertices?: Schema$GoogleCloudVisionV1p5beta1NormalizedVertex[]; + normalizedVertices?: Schema$GoogleCloudVisionV1p4beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ - vertices?: Schema$GoogleCloudVisionV1p5beta1Vertex[]; + vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; } /** * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ColorInfo { + export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { /** * RGB components of the color. */ @@ -4511,11 +3514,11 @@ export namespace vision_v1 { /** * Single crop hint that is used to generate a new crop when serving an image. */ - export interface Schema$GoogleCloudVisionV1p5beta1CropHint { + export interface Schema$GoogleCloudVisionV1p4beta1CropHint { /** * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of this being a salient region. Range [0, 1]. */ @@ -4528,29 +3531,29 @@ export namespace vision_v1 { /** * Set of crop hints that are used to generate new crops when serving images. */ - export interface Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation { /** * Crop hint results. */ - cropHints?: Schema$GoogleCloudVisionV1p5beta1CropHint[]; + cropHints?: Schema$GoogleCloudVisionV1p4beta1CropHint[]; } /** * Set of dominant colors and their corresponding scores. */ - export interface Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation { /** * RGB color values with their score and pixel fraction. */ - colors?: Schema$GoogleCloudVisionV1p5beta1ColorInfo[]; + colors?: Schema$GoogleCloudVisionV1p4beta1ColorInfo[]; } /** * Set of detected entity features. */ - export interface Schema$GoogleCloudVisionV1p5beta1EntityAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { /** * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ @@ -4566,7 +3569,7 @@ export namespace vision_v1 { /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ - locations?: Schema$GoogleCloudVisionV1p5beta1LocationInfo[]; + locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ @@ -4574,7 +3577,7 @@ export namespace vision_v1 { /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ - properties?: Schema$GoogleCloudVisionV1p5beta1Property[]; + properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; /** * Overall score of the result. Range [0, 1]. */ @@ -4587,7 +3590,7 @@ export namespace vision_v1 { /** * A face annotation object contains the results of face detection. */ - export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotation { /** * Anger likelihood. */ @@ -4599,7 +3602,7 @@ export namespace vision_v1 { /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Detection confidence. Range [0, 1]. */ @@ -4607,7 +3610,7 @@ export namespace vision_v1 { /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ - fdBoundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Headwear likelihood. */ @@ -4623,7 +3626,7 @@ export namespace vision_v1 { /** * Detected face landmarks. */ - landmarks?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark[]; + landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ @@ -4652,11 +3655,11 @@ export namespace vision_v1 { /** * A face-specific landmark (for example, a face feature). */ - export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark { + export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { /** * Face landmark position. */ - position?: Schema$GoogleCloudVisionV1p5beta1Position; + position?: Schema$GoogleCloudVisionV1p4beta1Position; /** * Face landmark type. */ @@ -4665,7 +3668,7 @@ export namespace vision_v1 { /** * The Google Cloud Storage location where the output will be written to. */ - export interface Schema$GoogleCloudVisionV1p5beta1GcsDestination { + export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ @@ -4674,7 +3677,7 @@ export namespace vision_v1 { /** * The Google Cloud Storage location where the input will be read from. */ - export interface Schema$GoogleCloudVisionV1p5beta1GcsSource { + export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ @@ -4683,7 +3686,7 @@ export namespace vision_v1 { /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext { + export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ @@ -4696,20 +3699,20 @@ export namespace vision_v1 { /** * Stores image properties, such as dominant colors. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImageProperties { + export interface Schema$GoogleCloudVisionV1p4beta1ImageProperties { /** * If present, dominant colors completed successfully. */ - dominantColors?: Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation; + dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImportProductSetsResponse { + export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** * The list of reference_images that are imported successfully. */ - referenceImages?: Schema$GoogleCloudVisionV1p5beta1ReferenceImage[]; + referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ @@ -4718,7 +3721,7 @@ export namespace vision_v1 { /** * The desired input location and metadata. */ - export interface Schema$GoogleCloudVisionV1p5beta1InputConfig { + export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ @@ -4726,45 +3729,20 @@ export namespace vision_v1 { /** * The Google Cloud Storage location to read the input from. */ - gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; + gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string | null; } - /** - * Proto for a key value pair. - */ - export interface Schema$GoogleCloudVisionV1p5beta1KeyValuePair { - /** - * The key string value. - */ - key?: string | null; - /** - * Key block of the pair containing the normalized bounding box and key text. - */ - keyBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - /** - * Optional. The translation of key text if the text is not in English. - */ - normalizedKey?: string | null; - /** - * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. - */ - valueBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - /** - * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. - */ - valueType?: string | null; - } /** * Set of detected objects with bounding boxes. */ - export interface Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation { /** * Image region to which this object belongs. This must be populated. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ @@ -4785,7 +3763,7 @@ export namespace vision_v1 { /** * Detected entity location information. */ - export interface Schema$GoogleCloudVisionV1p5beta1LocationInfo { + export interface Schema$GoogleCloudVisionV1p4beta1LocationInfo { /** * lat/long location coordinates. */ @@ -4794,7 +3772,7 @@ export namespace vision_v1 { /** * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ - export interface Schema$GoogleCloudVisionV1p5beta1NormalizedVertex { + export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { /** * X coordinate. */ @@ -4807,7 +3785,7 @@ export namespace vision_v1 { /** * Contains metadata for the BatchAnnotateImages operation. */ - export interface Schema$GoogleCloudVisionV1p5beta1OperationMetadata { + export interface Schema$GoogleCloudVisionV1p4beta1OperationMetadata { /** * The time when the batch request was received. */ @@ -4824,7 +3802,7 @@ export namespace vision_v1 { /** * The desired output location and metadata. */ - export interface Schema$GoogleCloudVisionV1p5beta1OutputConfig { + export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ @@ -4832,16 +3810,16 @@ export namespace vision_v1 { /** * The Google Cloud Storage location to write the output(s) to. */ - gcsDestination?: Schema$GoogleCloudVisionV1p5beta1GcsDestination; + gcsDestination?: Schema$GoogleCloudVisionV1p4beta1GcsDestination; } /** * Detected page from OCR. */ - export interface Schema$GoogleCloudVisionV1p5beta1Page { + export interface Schema$GoogleCloudVisionV1p4beta1Page { /** * List of blocks of text, images etc on this page. */ - blocks?: Schema$GoogleCloudVisionV1p5beta1Block[]; + blocks?: Schema$GoogleCloudVisionV1p4beta1Block[]; /** * Confidence of the OCR results on the page. Range [0, 1]. */ @@ -4850,14 +3828,10 @@ export namespace vision_v1 { * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number | null; - /** - * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. - */ - mergedText?: string | null; /** * Additional information detected on the page. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ @@ -4866,32 +3840,28 @@ export namespace vision_v1 { /** * Structural unit of text representing a number of words in certain order. */ - export interface Schema$GoogleCloudVisionV1p5beta1Paragraph { + export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ confidence?: number | null; - /** - * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. - */ - mergedText?: string | null; /** * Additional information detected for the paragraph. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * List of all words in this paragraph. */ - words?: Schema$GoogleCloudVisionV1p5beta1Word[]; + words?: Schema$GoogleCloudVisionV1p4beta1Word[]; } /** * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ - export interface Schema$GoogleCloudVisionV1p5beta1Position { + export interface Schema$GoogleCloudVisionV1p4beta1Position { /** * X coordinate. */ @@ -4908,7 +3878,7 @@ export namespace vision_v1 { /** * A Product contains ReferenceImages. */ - export interface Schema$GoogleCloudVisionV1p5beta1Product { + export interface Schema$GoogleCloudVisionV1p4beta1Product { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ @@ -4922,18 +3892,18 @@ export namespace vision_v1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ - productLabels?: Schema$GoogleCloudVisionV1p5beta1ProductKeyValue[]; + productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } /** * A product label represented as a key-value pair. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductKeyValue { + export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ @@ -4946,7 +3916,7 @@ export namespace vision_v1 { /** * Results for a product search request. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResults { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ @@ -4954,33 +3924,33 @@ export namespace vision_v1 { /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ - productGroupedResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult[]; + productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; /** * List of results, one for each product match. */ - results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** * Information about the products similar to a single product in a query image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { /** * The bounding polygon around the product detected in the query image. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * List of generic predictions for the object in the bounding box. */ - objectAnnotations?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsObjectAnnotation[]; + objectAnnotations?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation[]; /** * List of results, one for each product match. */ - results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** * Prediction for what the object in the bounding box is. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsObjectAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ @@ -5001,7 +3971,7 @@ export namespace vision_v1 { /** * Information about a product. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { /** * The resource name of the image from the product that is the closest match to the query. */ @@ -5009,7 +3979,7 @@ export namespace vision_v1 { /** * The Product. */ - product?: Schema$GoogleCloudVisionV1p5beta1Product; + product?: Schema$GoogleCloudVisionV1p4beta1Product; /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ @@ -5018,7 +3988,7 @@ export namespace vision_v1 { /** * A `Property` consists of a user-supplied name/value pair. */ - export interface Schema$GoogleCloudVisionV1p5beta1Property { + export interface Schema$GoogleCloudVisionV1p4beta1Property { /** * Name of the property. */ @@ -5035,77 +4005,53 @@ export namespace vision_v1 { /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ - export interface Schema$GoogleCloudVisionV1p5beta1ReferenceImage { + export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ - boundingPolys?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly[]; + boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ - export interface Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | null; } /** * A single symbol representation. */ - export interface Schema$GoogleCloudVisionV1p5beta1Symbol { + export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ @@ -5113,63 +4059,20 @@ export namespace vision_v1 { /** * Additional information detected for the symbol. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * The actual UTF-8 representation of the symbol. */ text?: string | null; } - /** - * A table representation similar to HTML table structure. - */ - export interface Schema$GoogleCloudVisionV1p5beta1Table { - /** - * Body rows of the table - */ - bodyRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; - /** - * Header rows of the table - */ - headerRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; - } - /** - * A cell representation inside of tables. - */ - export interface Schema$GoogleCloudVisionV1p5beta1TableTableCell { - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - /** - * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. - */ - text?: string | null; - /** - * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. - */ - textBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - } - /** - * A row of table cells. - */ - export interface Schema$GoogleCloudVisionV1p5beta1TableTableRow { - /** - * Cells that make up this row. - */ - cells?: Schema$GoogleCloudVisionV1p5beta1TableTableCell[]; - } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** * List of pages detected by OCR. */ - pages?: Schema$GoogleCloudVisionV1p5beta1Page[]; + pages?: Schema$GoogleCloudVisionV1p4beta1Page[]; /** * UTF-8 text detected on the pages. */ @@ -5178,7 +4081,7 @@ export namespace vision_v1 { /** * Detected start or end of a structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak { /** * True if break prepends the element. */ @@ -5191,7 +4094,7 @@ export namespace vision_v1 { /** * Detected language for a structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage { /** * Confidence of detected language. Range [0, 1]. */ @@ -5204,20 +4107,20 @@ export namespace vision_v1 { /** * Additional information detected on the structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty { /** * Detected start or end of a text segment. */ - detectedBreak?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak; + detectedBreak?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak; /** * A list of detected languages together with confidence. */ - detectedLanguages?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage[]; + detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; } /** * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ - export interface Schema$GoogleCloudVisionV1p5beta1Vertex { + export interface Schema$GoogleCloudVisionV1p4beta1Vertex { /** * X coordinate. */ @@ -5230,36 +4133,36 @@ export namespace vision_v1 { /** * Relevant information for the image from the Internet. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetection { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { /** * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ - bestGuessLabels?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel[]; + bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; /** * Fully matching images from the Internet. Can include resized copies of the query image. */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Web pages containing the matching images from the Internet. */ - pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage[]; + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; /** * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * The visually similar image results. */ - visuallySimilarImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + visuallySimilarImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Deduced entities from similar images on the Internet. */ - webEntities?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity[]; + webEntities?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity[]; } /** * Entity deduced from similar images on the Internet. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity { /** * Canonical description of the entity, in English. */ @@ -5276,7 +4179,7 @@ export namespace vision_v1 { /** * Metadata for online images. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage { /** * (Deprecated) Overall relevancy score for the image. */ @@ -5289,7 +4192,7 @@ export namespace vision_v1 { /** * Label to provide extra metadata for the web detection. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel { /** * Label for extra metadata. */ @@ -5302,11 +4205,11 @@ export namespace vision_v1 { /** * Metadata for web pages. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { /** * Fully matching images on the page. Can include resized copies of the query image. */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Title for the web page, may contain HTML markups. */ @@ -5314,7 +4217,7 @@ export namespace vision_v1 { /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * (Deprecated) Overall relevancy score for the web page. */ @@ -5327,27 +4230,23 @@ export namespace vision_v1 { /** * A word representation. */ - export interface Schema$GoogleCloudVisionV1p5beta1Word { + export interface Schema$GoogleCloudVisionV1p4beta1Word { /** * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the word. Range [0, 1]. */ confidence?: number | null; - /** - * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. - */ - mergedText?: string | null; /** * Additional information detected for the word. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * List of symbols in the word. The order of the symbols follows the natural reading order. */ - symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; + symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; } /** * Information about the products similar to a single product in a query image. @@ -5462,7 +4361,7 @@ export namespace vision_v1 { */ export interface Schema$ImportProductSetsRequest { /** - * The input content for the list of requests. + * Required. The input content for the list of requests. */ inputConfig?: Schema$ImportProductSetsInputConfig; } @@ -5820,7 +4719,7 @@ export namespace vision_v1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -5833,7 +4732,7 @@ export namespace vision_v1 { */ export interface Schema$ProductSearchParams { /** - * The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. + * The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied. */ boundingPoly?: Schema$BoundingPoly; /** @@ -5841,7 +4740,7 @@ export namespace vision_v1 { */ filter?: string | null; /** - * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ productCategories?: string[] | null; /** @@ -5935,7 +4834,7 @@ export namespace vision_v1 { */ export interface Schema$ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** @@ -5943,7 +4842,7 @@ export namespace vision_v1 { */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -5952,7 +4851,7 @@ export namespace vision_v1 { */ export interface Schema$RemoveProductFromProductSetRequest { /** - * The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Required. The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ product?: string | null; } @@ -5981,46 +4880,22 @@ export namespace vision_v1 { * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | 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). @@ -8516,7 +7391,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {string=} params.productId A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().Product} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8635,7 +7510,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * @param {string} params.name Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_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 @@ -8752,7 +7627,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * @param {string} params.name Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_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 @@ -8884,7 +7759,7 @@ export namespace vision_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. - * @param {string} params.parent The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` + * @param {string} params.parent Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_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 @@ -9085,7 +7960,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {().PurgeProductsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9162,7 +8037,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** @@ -9183,7 +8058,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ name?: string; } @@ -9195,7 +8070,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + * Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` */ name?: string; } @@ -9215,7 +8090,7 @@ export namespace vision_v1 { */ pageToken?: string; /** - * The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` + * Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` */ parent?: string; } @@ -9248,7 +8123,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; @@ -9323,7 +8198,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * @param {string} params.parent Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. * @param {string=} params.referenceImageId A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().ReferenceImage} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9444,7 +8319,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + * @param {string} params.name Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_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 @@ -9561,7 +8436,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * @param {string} params.name Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_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 @@ -9695,7 +8570,7 @@ export namespace vision_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified. - * @param {string} params.parent Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * @param {string} params.parent Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_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 @@ -9778,7 +8653,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. */ parent?: string; /** @@ -9799,7 +8674,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` + * Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID` */ name?: string; } @@ -9811,7 +8686,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. + * Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. */ name?: string; } @@ -9831,7 +8706,7 @@ export namespace vision_v1 { */ pageToken?: string; /** - * Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + * Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. */ parent?: string; } @@ -9902,7 +8777,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {().AddProductToProductSetRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10026,7 +8901,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {string=} params.productSetId A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. * @param {().ProductSet} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10147,7 +9022,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_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 @@ -10264,7 +9139,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_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 @@ -10386,7 +9261,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. * @param {().ImportProductSetsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10523,7 +9398,7 @@ export namespace vision_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. - * @param {string} params.parent The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * @param {string} params.parent Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_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 @@ -10775,7 +9650,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {().RemoveProductFromProductSetRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -10850,7 +9725,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; @@ -10867,7 +9742,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; /** @@ -10888,7 +9763,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; } @@ -10900,7 +9775,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` + * Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` */ name?: string; } @@ -10912,7 +9787,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; @@ -10937,7 +9812,7 @@ export namespace vision_v1 { */ pageToken?: string; /** - * The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. + * Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. */ parent?: string; } @@ -10970,7 +9845,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; @@ -11054,7 +9929,7 @@ export namespace vision_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * @param {string} params.name Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` * @param {integer=} params.pageSize The maximum number of items to return. Default 10, maximum 100. * @param {string=} params.pageToken The next_page_token returned from a previous List request, if any. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11141,7 +10016,7 @@ export namespace vision_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + * Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` */ name?: string; /** diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index ab78d345513..91fd2d9b2a2 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -676,7 +676,7 @@ export namespace vision_v1p1beta1 { */ parent?: string | null; /** - * Individual async file annotation requests for this batch. + * Required. Individual async file annotation requests for this batch. */ requests?: Schema$GoogleCloudVisionV1p1beta1AsyncAnnotateFileRequest[]; } @@ -702,7 +702,7 @@ export namespace vision_v1p1beta1 { */ parent?: string | null; /** - * Individual image annotation requests for this batch. + * Required. Individual image annotation requests for this batch. */ requests?: Schema$GoogleCloudVisionV1p1beta1AnnotateImageRequest[]; } @@ -715,7 +715,7 @@ export namespace vision_v1p1beta1 { */ parent?: string | null; /** - * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. + * Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. */ requests?: Schema$GoogleCloudVisionV1p1beta1AnnotateFileRequest[]; } @@ -737,7 +737,7 @@ export namespace vision_v1p1beta1 { */ parent?: string | null; /** - * Individual image annotation requests for this batch. + * Required. Individual image annotation requests for this batch. */ requests?: Schema$GoogleCloudVisionV1p1beta1AnnotateImageRequest[]; } @@ -1263,7 +1263,7 @@ export namespace vision_v1p1beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -1289,7 +1289,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p1beta1ProductSearchParams { /** - * The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. + * The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied. */ boundingPoly?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1297,7 +1297,7 @@ export namespace vision_v1p1beta1 { */ filter?: string | null; /** - * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ productCategories?: string[] | null; /** @@ -2155,7 +2155,7 @@ export namespace vision_v1p1beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -3047,7 +3047,7 @@ export namespace vision_v1p1beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -3162,7 +3162,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** @@ -3170,7 +3170,7 @@ export namespace vision_v1p1beta1 { */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -3452,1064 +3452,79 @@ export namespace vision_v1p1beta1 { * If present, image properties were extracted successfully. */ imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p4beta1ImageProperties; - /** - * If present, image quality calculation has completed successfully. - */ - imageQualityAnnotation?: Schema$GoogleCloudVisionV1p4beta1ImageQuality; - /** - * If present, label detection has completed successfully. - */ - labelAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, landmark detection has completed successfully. - */ - landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. - */ - localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; - /** - * If present, logo detection has completed successfully. - */ - logoAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, product search has completed successfully. - */ - productSearchResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResults; - /** - * If present, image quality optimization has completed successfully. - */ - qualityOptimizationResult?: Schema$GoogleCloudVisionV1p4beta1QualityOptimizationResult; - /** - * If present, safe-search annotation has completed successfully. - */ - safeSearchAnnotation?: Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation; - /** - * If present, text (OCR) detection has completed successfully. - */ - textAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, web detection has completed successfully. - */ - webDetection?: Schema$GoogleCloudVisionV1p4beta1WebDetection; - } - /** - * The response for a single offline file annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse { - /** - * The output location and metadata from AsyncAnnotateFileRequest. - */ - outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; - } - /** - * Response to an async batch file annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { - /** - * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. - */ - responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; - } - /** - * Response to an async batch image annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse { - /** - * The output location and metadata from AsyncBatchAnnotateImagesRequest. - */ - outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; - } - /** - * A list of file annotation responses. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { - /** - * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. - */ - responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; - } - /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { - /** - * The time when the batch request is finished and google.longrunning.Operation.done is set to true. - */ - endTime?: string | null; - /** - * The current state of the batch operation. - */ - state?: string | null; - /** - * The time when the batch request was submitted to the server. - */ - submitTime?: string | null; - } - /** - * Logical element on the page. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Block { - /** - * Detected block type (text, image etc) for this block. - */ - blockType?: string | null; - /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results on the block. Range [0, 1]. - */ - confidence?: number | null; - /** - * List of paragraphs in this block (if this blocks is of type text). - */ - paragraphs?: Schema$GoogleCloudVisionV1p4beta1Paragraph[]; - /** - * Additional information detected for the block. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BoundingPoly { - /** - * The bounding polygon normalized vertices. - */ - normalizedVertices?: Schema$GoogleCloudVisionV1p4beta1NormalizedVertex[]; - /** - * The bounding polygon vertices. - */ - vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; - } - /** - * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { - /** - * RGB components of the color. - */ - color?: Schema$Color; - /** - * The fraction of pixels the color occupies in the image. Value in range [0, 1]. - */ - pixelFraction?: number | null; - /** - * Image-specific score for this color. Value in range [0, 1]. - */ - score?: number | null; - } - /** - * Single crop hint that is used to generate a new crop when serving an image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1CropHint { - /** - * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of this being a salient region. Range [0, 1]. - */ - confidence?: number | null; - /** - * Fraction of importance of this salient region with respect to the original image. - */ - importanceFraction?: number | null; - } - /** - * Set of crop hints that are used to generate new crops when serving images. - */ - export interface Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation { - /** - * Crop hint results. - */ - cropHints?: Schema$GoogleCloudVisionV1p4beta1CropHint[]; - } - /** - * Set of dominant colors and their corresponding scores. - */ - export interface Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation { - /** - * RGB color values with their score and pixel fraction. - */ - colors?: Schema$GoogleCloudVisionV1p4beta1ColorInfo[]; - } - /** - * Set of detected entity features. - */ - export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { - /** - * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. - */ - confidence?: number | null; - /** - * Entity textual description, expressed in its `locale` language. - */ - description?: string | null; - /** - * The language code for the locale in which the entity textual `description` is expressed. - */ - locale?: string | null; - /** - * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. - */ - locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; - /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). - */ - mid?: string | null; - /** - * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. - */ - properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; - /** - * Overall score of the result. Range [0, 1]. - */ - score?: number | null; - /** - * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. - */ - topicality?: number | null; - } - /** - * A face annotation object contains the results of face detection. - */ - export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotation { - /** - * Anger likelihood. - */ - angerLikelihood?: string | null; - /** - * Blurred likelihood. - */ - blurredLikelihood?: string | null; - /** - * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Detection confidence. Range [0, 1]. - */ - detectionConfidence?: number | null; - /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. - */ - fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Headwear likelihood. - */ - headwearLikelihood?: string | null; - /** - * Joy likelihood. - */ - joyLikelihood?: string | null; - /** - * Face landmarking confidence. Range [0, 1]. - */ - landmarkingConfidence?: number | null; - /** - * Detected face landmarks. - */ - landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; - /** - * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. - */ - panAngle?: number | null; - /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. - */ - rollAngle?: number | null; - /** - * Sorrow likelihood. - */ - sorrowLikelihood?: string | null; - /** - * Surprise likelihood. - */ - surpriseLikelihood?: string | null; - /** - * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. - */ - tiltAngle?: number | null; - /** - * Under-exposed likelihood. - */ - underExposedLikelihood?: string | null; - } - /** - * A face-specific landmark (for example, a face feature). - */ - export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { - /** - * Face landmark position. - */ - position?: Schema$GoogleCloudVisionV1p4beta1Position; - /** - * Face landmark type. - */ - type?: string | null; - } - /** - * The Google Cloud Storage location where the output will be written to. - */ - export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { - /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. - */ - uri?: string | null; - } - /** - * The Google Cloud Storage location where the input will be read from. - */ - export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { - /** - * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. - */ - uri?: string | null; - } - /** - * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { - /** - * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. - */ - pageNumber?: number | null; - /** - * The URI of the file used to produce the image. - */ - uri?: string | null; - } - /** - * Stores image properties, such as dominant colors. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageProperties { - /** - * If present, dominant colors completed successfully. - */ - dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; - } - /** - * Stores image quality scores, could be aesthetic quality or technical quality. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageQuality { - /** - * A score representing the aesthetic/technical quality of the image. The score is in range [0, 1]. Higher value corresponds to more professional looking photos. 0 means the image looks very bad, 1 means the image with very high quality. - */ - qualityScore?: number | null; - } - /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { - /** - * The list of reference_images that are imported successfully. - */ - referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; - /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. - */ - statuses?: Schema$Status[]; - } - /** - * The desired input location and metadata. - */ - export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { - /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. - */ - content?: string | null; - /** - * The Google Cloud Storage location to read the input from. - */ - gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; - /** - * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. - */ - mimeType?: string | null; - } - /** - * Set of detected objects with bounding boxes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation { - /** - * Image region to which this object belongs. This must be populated. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - /** - * Object ID that should align with EntityAnnotation mid. - */ - mid?: string | null; - /** - * Object name, expressed in its `language_code` language. - */ - name?: string | null; - /** - * Score of the result. Range [0, 1]. - */ - score?: number | null; - } - /** - * Detected entity location information. - */ - export interface Schema$GoogleCloudVisionV1p4beta1LocationInfo { - /** - * lat/long location coordinates. - */ - latLng?: Schema$LatLng; - } - /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. - */ - export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - } - /** - * Contains metadata for the BatchAnnotateImages operation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1OperationMetadata { - /** - * The time when the batch request was received. - */ - createTime?: string | null; - /** - * Current state of the batch operation. - */ - state?: string | null; - /** - * The time when the operation result was last updated. - */ - updateTime?: string | null; - } - /** - * The desired output location and metadata. - */ - export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { - /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. - */ - batchSize?: number | null; - /** - * The Google Cloud Storage location to write the output(s) to. - */ - gcsDestination?: Schema$GoogleCloudVisionV1p4beta1GcsDestination; - } - /** - * Detected page from OCR. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Page { - /** - * List of blocks of text, images etc on this page. - */ - blocks?: Schema$GoogleCloudVisionV1p4beta1Block[]; - /** - * Confidence of the OCR results on the page. Range [0, 1]. - */ - confidence?: number | null; - /** - * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. - */ - height?: number | null; - /** - * Additional information detected on the page. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. - */ - width?: number | null; - } - /** - * Structural unit of text representing a number of words in certain order. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { - /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the paragraph. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the paragraph. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * List of all words in this paragraph. - */ - words?: Schema$GoogleCloudVisionV1p4beta1Word[]; - } - /** - * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Position { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - /** - * Z coordinate (or depth). - */ - z?: number | null; - } - /** - * A Product contains ReferenceImages. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Product { - /** - * User-provided metadata to be stored with this product. Must be at most 4096 characters long. - */ - description?: string | null; - /** - * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. - */ - displayName?: string | null; - /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. - */ - name?: string | null; - /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. - */ - productCategory?: string | null; - /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. - */ - productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; - } - /** - * A product label represented as a key-value pair. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { - /** - * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. - */ - key?: string | null; - /** - * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. - */ - value?: string | null; - } - /** - * Results for a product search request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { - /** - * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. - */ - indexTime?: string | null; - /** - * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. - */ - productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; - /** - * List of results, one for each product match. - */ - results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; - } - /** - * Information about the products similar to a single product in a query image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { - /** - * The bounding polygon around the product detected in the query image. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * List of generic predictions for the object in the bounding box. - */ - objectAnnotations?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation[]; - /** - * List of results, one for each product match. - */ - results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; - } - /** - * Prediction for what the object in the bounding box is. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation { - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - /** - * Object ID that should align with EntityAnnotation mid. - */ - mid?: string | null; - /** - * Object name, expressed in its `language_code` language. - */ - name?: string | null; - /** - * Score of the result. Range [0, 1]. - */ - score?: number | null; - } - /** - * Information about a product. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { - /** - * The resource name of the image from the product that is the closest match to the query. - */ - image?: string | null; - /** - * The Product. - */ - product?: Schema$GoogleCloudVisionV1p4beta1Product; - /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). - */ - score?: number | null; - } - /** - * A `Property` consists of a user-supplied name/value pair. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Property { - /** - * Name of the property. - */ - name?: string | null; - /** - * Value of numeric properties. - */ - uint64Value?: string | null; - /** - * Value of the property. - */ - value?: string | null; - } - /** - * Stores enhanced image bytes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1QualityOptimizationResult { - /** - * Optimized image bytes. - */ - image?: string | null; - /** - * Mime type of the output image. - */ - mimeType?: string | null; - /** - * Required optimization type. - */ - qualityOptimizationType?: string | null; - } - /** - * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { - /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). - */ - boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; - /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. - */ - name?: string | null; - /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. - */ - uri?: string | null; - } - /** - * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). - */ - export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { - /** - * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. - */ - adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; - /** - * Likelihood that this is a medical image. - */ - medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; - /** - * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. - */ - racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; - /** - * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. - */ - spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; - /** - * Likelihood that this image contains violent content. - */ - violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | null; - } - /** - * A single symbol representation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Symbol { - /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the symbol. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the symbol. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * The actual UTF-8 representation of the symbol. - */ - text?: string | null; - } - /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { - /** - * List of pages detected by OCR. - */ - pages?: Schema$GoogleCloudVisionV1p4beta1Page[]; - /** - * UTF-8 text detected on the pages. - */ - text?: string | null; - } - /** - * Detected start or end of a structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak { - /** - * True if break prepends the element. - */ - isPrefix?: boolean | null; - /** - * Detected break type. - */ - type?: string | null; - } - /** - * Detected language for a structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage { - /** - * Confidence of detected language. Range [0, 1]. - */ - confidence?: number | null; - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - } - /** - * Additional information detected on the structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty { - /** - * Detected start or end of a text segment. - */ - detectedBreak?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; - } - /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Vertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - } - /** - * Relevant information for the image from the Internet. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { - /** - * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. - */ - bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; - /** - * Fully matching images from the Internet. Can include resized copies of the query image. - */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Web pages containing the matching images from the Internet. - */ - pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; - /** - * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. - */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * The visually similar image results. - */ - visuallySimilarImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Deduced entities from similar images on the Internet. - */ - webEntities?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity[]; - } - /** - * Entity deduced from similar images on the Internet. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity { - /** - * Canonical description of the entity, in English. - */ - description?: string | null; - /** - * Opaque entity ID. - */ - entityId?: string | null; - /** - * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. - */ - score?: number | null; - } - /** - * Metadata for online images. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage { - /** - * (Deprecated) Overall relevancy score for the image. - */ - score?: number | null; - /** - * The result image URL. - */ - url?: string | null; - } - /** - * Label to provide extra metadata for the web detection. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel { - /** - * Label for extra metadata. - */ - label?: string | null; - /** - * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - } - /** - * Metadata for web pages. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { - /** - * Fully matching images on the page. Can include resized copies of the query image. - */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Title for the web page, may contain HTML markups. - */ - pageTitle?: string | null; - /** - * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. - */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * (Deprecated) Overall relevancy score for the web page. - */ - score?: number | null; - /** - * The result web page URL. - */ - url?: string | null; - } - /** - * A word representation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Word { - /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the word. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the word. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * List of symbols in the word. The order of the symbols follows the natural reading order. - */ - symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; - } - /** - * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. - */ - export interface Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse { - /** - * If set, represents the error message for the failed request. The `responses` field will not be set in this case. - */ - error?: Schema$Status; - /** - * Information about the file for which this response is generated. - */ - inputConfig?: Schema$GoogleCloudVisionV1p5beta1InputConfig; - /** - * Individual responses to images found within the file. This field will be empty if the `error` field is set. - */ - responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse[]; - /** - * This field gives the total number of pages in the file. - */ - totalPages?: number | null; - } - /** - * Response to an image annotation request. - */ - export interface Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse { - /** - * If present, contextual information is needed to understand where this image comes from. - */ - context?: Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext; - /** - * If present, crop hints have completed successfully. - */ - cropHintsAnnotation?: Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation; - /** - * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. - */ - error?: Schema$Status; - /** - * If present, face detection has completed successfully. - */ - faceAnnotations?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotation[]; - /** - * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. - */ - fullTextAnnotation?: Schema$GoogleCloudVisionV1p5beta1TextAnnotation; - /** - * If present, image properties were extracted successfully. - */ - imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p5beta1ImageProperties; /** * If present, label detection has completed successfully. */ - labelAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + labelAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, landmark detection has completed successfully. */ - landmarkAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ - localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation[]; + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; /** * If present, logo detection has completed successfully. */ - logoAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + logoAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, product search has completed successfully. */ - productSearchResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResults; + productSearchResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ - safeSearchAnnotation?: Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation; + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation; /** * If present, text (OCR) detection has completed successfully. */ - textAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + textAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, web detection has completed successfully. */ - webDetection?: Schema$GoogleCloudVisionV1p5beta1WebDetection; + webDetection?: Schema$GoogleCloudVisionV1p4beta1WebDetection; } /** * The response for a single offline file annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse { /** * The output location and metadata from AsyncAnnotateFileRequest. */ - outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; + outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; } /** * Response to an async batch file annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateFilesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { /** * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ - responses?: Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse[]; + responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; } /** * Response to an async batch image annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateImagesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse { /** * The output location and metadata from AsyncBatchAnnotateImagesRequest. */ - outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; + outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; } /** * A list of file annotation responses. */ - export interface Schema$GoogleCloudVisionV1p5beta1BatchAnnotateFilesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { /** * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ - responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse[]; + responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ - export interface Schema$GoogleCloudVisionV1p5beta1BatchOperationMetadata { + export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ @@ -4526,7 +3541,7 @@ export namespace vision_v1p1beta1 { /** * Logical element on the page. */ - export interface Schema$GoogleCloudVisionV1p5beta1Block { + export interface Schema$GoogleCloudVisionV1p4beta1Block { /** * Detected block type (text, image etc) for this block. */ @@ -4534,49 +3549,37 @@ export namespace vision_v1p1beta1 { /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results on the block. Range [0, 1]. */ confidence?: number | null; - /** - * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. - */ - keyValuePair?: Schema$GoogleCloudVisionV1p5beta1KeyValuePair; - /** - * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. - */ - mergedText?: string | null; /** * List of paragraphs in this block (if this blocks is of type text). */ - paragraphs?: Schema$GoogleCloudVisionV1p5beta1Paragraph[]; + paragraphs?: Schema$GoogleCloudVisionV1p4beta1Paragraph[]; /** * Additional information detected for the block. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; - /** - * Detected table for TABLE block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. - */ - table?: Schema$GoogleCloudVisionV1p5beta1Table; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; } /** * A bounding polygon for the detected image annotation. */ - export interface Schema$GoogleCloudVisionV1p5beta1BoundingPoly { + export interface Schema$GoogleCloudVisionV1p4beta1BoundingPoly { /** * The bounding polygon normalized vertices. */ - normalizedVertices?: Schema$GoogleCloudVisionV1p5beta1NormalizedVertex[]; + normalizedVertices?: Schema$GoogleCloudVisionV1p4beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ - vertices?: Schema$GoogleCloudVisionV1p5beta1Vertex[]; + vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; } /** * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ColorInfo { + export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { /** * RGB components of the color. */ @@ -4593,11 +3596,11 @@ export namespace vision_v1p1beta1 { /** * Single crop hint that is used to generate a new crop when serving an image. */ - export interface Schema$GoogleCloudVisionV1p5beta1CropHint { + export interface Schema$GoogleCloudVisionV1p4beta1CropHint { /** * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of this being a salient region. Range [0, 1]. */ @@ -4610,29 +3613,29 @@ export namespace vision_v1p1beta1 { /** * Set of crop hints that are used to generate new crops when serving images. */ - export interface Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation { /** * Crop hint results. */ - cropHints?: Schema$GoogleCloudVisionV1p5beta1CropHint[]; + cropHints?: Schema$GoogleCloudVisionV1p4beta1CropHint[]; } /** * Set of dominant colors and their corresponding scores. */ - export interface Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation { /** * RGB color values with their score and pixel fraction. */ - colors?: Schema$GoogleCloudVisionV1p5beta1ColorInfo[]; + colors?: Schema$GoogleCloudVisionV1p4beta1ColorInfo[]; } /** * Set of detected entity features. */ - export interface Schema$GoogleCloudVisionV1p5beta1EntityAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { /** * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ @@ -4648,7 +3651,7 @@ export namespace vision_v1p1beta1 { /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ - locations?: Schema$GoogleCloudVisionV1p5beta1LocationInfo[]; + locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ @@ -4656,7 +3659,7 @@ export namespace vision_v1p1beta1 { /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ - properties?: Schema$GoogleCloudVisionV1p5beta1Property[]; + properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; /** * Overall score of the result. Range [0, 1]. */ @@ -4669,7 +3672,7 @@ export namespace vision_v1p1beta1 { /** * A face annotation object contains the results of face detection. */ - export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotation { /** * Anger likelihood. */ @@ -4681,7 +3684,7 @@ export namespace vision_v1p1beta1 { /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Detection confidence. Range [0, 1]. */ @@ -4689,7 +3692,7 @@ export namespace vision_v1p1beta1 { /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ - fdBoundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Headwear likelihood. */ @@ -4705,7 +3708,7 @@ export namespace vision_v1p1beta1 { /** * Detected face landmarks. */ - landmarks?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark[]; + landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ @@ -4734,11 +3737,11 @@ export namespace vision_v1p1beta1 { /** * A face-specific landmark (for example, a face feature). */ - export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark { + export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { /** * Face landmark position. */ - position?: Schema$GoogleCloudVisionV1p5beta1Position; + position?: Schema$GoogleCloudVisionV1p4beta1Position; /** * Face landmark type. */ @@ -4747,7 +3750,7 @@ export namespace vision_v1p1beta1 { /** * The Google Cloud Storage location where the output will be written to. */ - export interface Schema$GoogleCloudVisionV1p5beta1GcsDestination { + export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ @@ -4756,7 +3759,7 @@ export namespace vision_v1p1beta1 { /** * The Google Cloud Storage location where the input will be read from. */ - export interface Schema$GoogleCloudVisionV1p5beta1GcsSource { + export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ @@ -4765,7 +3768,7 @@ export namespace vision_v1p1beta1 { /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext { + export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ @@ -4778,20 +3781,20 @@ export namespace vision_v1p1beta1 { /** * Stores image properties, such as dominant colors. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImageProperties { + export interface Schema$GoogleCloudVisionV1p4beta1ImageProperties { /** * If present, dominant colors completed successfully. */ - dominantColors?: Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation; + dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImportProductSetsResponse { + export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** * The list of reference_images that are imported successfully. */ - referenceImages?: Schema$GoogleCloudVisionV1p5beta1ReferenceImage[]; + referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ @@ -4800,7 +3803,7 @@ export namespace vision_v1p1beta1 { /** * The desired input location and metadata. */ - export interface Schema$GoogleCloudVisionV1p5beta1InputConfig { + export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ @@ -4808,45 +3811,20 @@ export namespace vision_v1p1beta1 { /** * The Google Cloud Storage location to read the input from. */ - gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; + gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string | null; } - /** - * Proto for a key value pair. - */ - export interface Schema$GoogleCloudVisionV1p5beta1KeyValuePair { - /** - * The key string value. - */ - key?: string | null; - /** - * Key block of the pair containing the normalized bounding box and key text. - */ - keyBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - /** - * Optional. The translation of key text if the text is not in English. - */ - normalizedKey?: string | null; - /** - * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. - */ - valueBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - /** - * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. - */ - valueType?: string | null; - } /** * Set of detected objects with bounding boxes. */ - export interface Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation { /** * Image region to which this object belongs. This must be populated. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ @@ -4867,7 +3845,7 @@ export namespace vision_v1p1beta1 { /** * Detected entity location information. */ - export interface Schema$GoogleCloudVisionV1p5beta1LocationInfo { + export interface Schema$GoogleCloudVisionV1p4beta1LocationInfo { /** * lat/long location coordinates. */ @@ -4876,7 +3854,7 @@ export namespace vision_v1p1beta1 { /** * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ - export interface Schema$GoogleCloudVisionV1p5beta1NormalizedVertex { + export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { /** * X coordinate. */ @@ -4889,7 +3867,7 @@ export namespace vision_v1p1beta1 { /** * Contains metadata for the BatchAnnotateImages operation. */ - export interface Schema$GoogleCloudVisionV1p5beta1OperationMetadata { + export interface Schema$GoogleCloudVisionV1p4beta1OperationMetadata { /** * The time when the batch request was received. */ @@ -4906,7 +3884,7 @@ export namespace vision_v1p1beta1 { /** * The desired output location and metadata. */ - export interface Schema$GoogleCloudVisionV1p5beta1OutputConfig { + export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ @@ -4914,16 +3892,16 @@ export namespace vision_v1p1beta1 { /** * The Google Cloud Storage location to write the output(s) to. */ - gcsDestination?: Schema$GoogleCloudVisionV1p5beta1GcsDestination; + gcsDestination?: Schema$GoogleCloudVisionV1p4beta1GcsDestination; } /** * Detected page from OCR. */ - export interface Schema$GoogleCloudVisionV1p5beta1Page { + export interface Schema$GoogleCloudVisionV1p4beta1Page { /** * List of blocks of text, images etc on this page. */ - blocks?: Schema$GoogleCloudVisionV1p5beta1Block[]; + blocks?: Schema$GoogleCloudVisionV1p4beta1Block[]; /** * Confidence of the OCR results on the page. Range [0, 1]. */ @@ -4932,14 +3910,10 @@ export namespace vision_v1p1beta1 { * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number | null; - /** - * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. - */ - mergedText?: string | null; /** * Additional information detected on the page. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ @@ -4948,32 +3922,28 @@ export namespace vision_v1p1beta1 { /** * Structural unit of text representing a number of words in certain order. */ - export interface Schema$GoogleCloudVisionV1p5beta1Paragraph { + export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ confidence?: number | null; - /** - * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. - */ - mergedText?: string | null; /** * Additional information detected for the paragraph. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * List of all words in this paragraph. */ - words?: Schema$GoogleCloudVisionV1p5beta1Word[]; + words?: Schema$GoogleCloudVisionV1p4beta1Word[]; } /** * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ - export interface Schema$GoogleCloudVisionV1p5beta1Position { + export interface Schema$GoogleCloudVisionV1p4beta1Position { /** * X coordinate. */ @@ -4990,7 +3960,7 @@ export namespace vision_v1p1beta1 { /** * A Product contains ReferenceImages. */ - export interface Schema$GoogleCloudVisionV1p5beta1Product { + export interface Schema$GoogleCloudVisionV1p4beta1Product { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ @@ -5004,18 +3974,18 @@ export namespace vision_v1p1beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ - productLabels?: Schema$GoogleCloudVisionV1p5beta1ProductKeyValue[]; + productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } /** * A product label represented as a key-value pair. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductKeyValue { + export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ @@ -5028,7 +3998,7 @@ export namespace vision_v1p1beta1 { /** * Results for a product search request. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResults { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ @@ -5036,33 +4006,33 @@ export namespace vision_v1p1beta1 { /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ - productGroupedResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult[]; + productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; /** * List of results, one for each product match. */ - results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** * Information about the products similar to a single product in a query image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { /** * The bounding polygon around the product detected in the query image. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * List of generic predictions for the object in the bounding box. */ - objectAnnotations?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsObjectAnnotation[]; + objectAnnotations?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation[]; /** * List of results, one for each product match. */ - results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** * Prediction for what the object in the bounding box is. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsObjectAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ @@ -5083,7 +4053,7 @@ export namespace vision_v1p1beta1 { /** * Information about a product. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { /** * The resource name of the image from the product that is the closest match to the query. */ @@ -5091,7 +4061,7 @@ export namespace vision_v1p1beta1 { /** * The Product. */ - product?: Schema$GoogleCloudVisionV1p5beta1Product; + product?: Schema$GoogleCloudVisionV1p4beta1Product; /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ @@ -5100,7 +4070,7 @@ export namespace vision_v1p1beta1 { /** * A `Property` consists of a user-supplied name/value pair. */ - export interface Schema$GoogleCloudVisionV1p5beta1Property { + export interface Schema$GoogleCloudVisionV1p4beta1Property { /** * Name of the property. */ @@ -5117,77 +4087,53 @@ export namespace vision_v1p1beta1 { /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ - export interface Schema$GoogleCloudVisionV1p5beta1ReferenceImage { + export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ - boundingPolys?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly[]; + boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ - export interface Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | null; } /** * A single symbol representation. */ - export interface Schema$GoogleCloudVisionV1p5beta1Symbol { + export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ @@ -5195,63 +4141,20 @@ export namespace vision_v1p1beta1 { /** * Additional information detected for the symbol. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * The actual UTF-8 representation of the symbol. */ text?: string | null; } - /** - * A table representation similar to HTML table structure. - */ - export interface Schema$GoogleCloudVisionV1p5beta1Table { - /** - * Body rows of the table - */ - bodyRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; - /** - * Header rows of the table - */ - headerRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; - } - /** - * A cell representation inside of tables. - */ - export interface Schema$GoogleCloudVisionV1p5beta1TableTableCell { - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - /** - * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. - */ - text?: string | null; - /** - * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. - */ - textBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - } - /** - * A row of table cells. - */ - export interface Schema$GoogleCloudVisionV1p5beta1TableTableRow { - /** - * Cells that make up this row. - */ - cells?: Schema$GoogleCloudVisionV1p5beta1TableTableCell[]; - } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** * List of pages detected by OCR. */ - pages?: Schema$GoogleCloudVisionV1p5beta1Page[]; + pages?: Schema$GoogleCloudVisionV1p4beta1Page[]; /** * UTF-8 text detected on the pages. */ @@ -5260,7 +4163,7 @@ export namespace vision_v1p1beta1 { /** * Detected start or end of a structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak { /** * True if break prepends the element. */ @@ -5273,7 +4176,7 @@ export namespace vision_v1p1beta1 { /** * Detected language for a structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage { /** * Confidence of detected language. Range [0, 1]. */ @@ -5286,20 +4189,20 @@ export namespace vision_v1p1beta1 { /** * Additional information detected on the structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty { /** * Detected start or end of a text segment. */ - detectedBreak?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak; + detectedBreak?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak; /** * A list of detected languages together with confidence. */ - detectedLanguages?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage[]; + detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; } /** * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ - export interface Schema$GoogleCloudVisionV1p5beta1Vertex { + export interface Schema$GoogleCloudVisionV1p4beta1Vertex { /** * X coordinate. */ @@ -5312,36 +4215,36 @@ export namespace vision_v1p1beta1 { /** * Relevant information for the image from the Internet. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetection { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { /** * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ - bestGuessLabels?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel[]; + bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; /** * Fully matching images from the Internet. Can include resized copies of the query image. */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Web pages containing the matching images from the Internet. */ - pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage[]; + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; /** * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * The visually similar image results. */ - visuallySimilarImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + visuallySimilarImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Deduced entities from similar images on the Internet. */ - webEntities?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity[]; + webEntities?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity[]; } /** * Entity deduced from similar images on the Internet. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity { /** * Canonical description of the entity, in English. */ @@ -5358,7 +4261,7 @@ export namespace vision_v1p1beta1 { /** * Metadata for online images. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage { /** * (Deprecated) Overall relevancy score for the image. */ @@ -5371,7 +4274,7 @@ export namespace vision_v1p1beta1 { /** * Label to provide extra metadata for the web detection. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel { /** * Label for extra metadata. */ @@ -5384,11 +4287,11 @@ export namespace vision_v1p1beta1 { /** * Metadata for web pages. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { /** * Fully matching images on the page. Can include resized copies of the query image. */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Title for the web page, may contain HTML markups. */ @@ -5396,7 +4299,7 @@ export namespace vision_v1p1beta1 { /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * (Deprecated) Overall relevancy score for the web page. */ @@ -5409,27 +4312,23 @@ export namespace vision_v1p1beta1 { /** * A word representation. */ - export interface Schema$GoogleCloudVisionV1p5beta1Word { + export interface Schema$GoogleCloudVisionV1p4beta1Word { /** * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the word. Range [0, 1]. */ confidence?: number | null; - /** - * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. - */ - mergedText?: string | null; /** * Additional information detected for the word. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * List of symbols in the word. The order of the symbols follows the natural reading order. */ - symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; + symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; } /** * Information about the products similar to a single product in a query image. @@ -5742,7 +4641,7 @@ export namespace vision_v1p1beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -5789,7 +4688,7 @@ export namespace vision_v1p1beta1 { */ export interface Schema$ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** @@ -5797,7 +4696,7 @@ export namespace vision_v1p1beta1 { */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -5826,46 +4725,22 @@ export namespace vision_v1p1beta1 { * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | 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). diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index 9db2106f015..ab2c10e5b19 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -1040,7 +1040,7 @@ export namespace vision_v1p2beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -1538,7 +1538,7 @@ export namespace vision_v1p2beta1 { */ parent?: string | null; /** - * Individual async file annotation requests for this batch. + * Required. Individual async file annotation requests for this batch. */ requests?: Schema$GoogleCloudVisionV1p2beta1AsyncAnnotateFileRequest[]; } @@ -1564,7 +1564,7 @@ export namespace vision_v1p2beta1 { */ parent?: string | null; /** - * Individual image annotation requests for this batch. + * Required. Individual image annotation requests for this batch. */ requests?: Schema$GoogleCloudVisionV1p2beta1AnnotateImageRequest[]; } @@ -1577,7 +1577,7 @@ export namespace vision_v1p2beta1 { */ parent?: string | null; /** - * The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. + * Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. */ requests?: Schema$GoogleCloudVisionV1p2beta1AnnotateFileRequest[]; } @@ -1599,7 +1599,7 @@ export namespace vision_v1p2beta1 { */ parent?: string | null; /** - * Individual image annotation requests for this batch. + * Required. Individual image annotation requests for this batch. */ requests?: Schema$GoogleCloudVisionV1p2beta1AnnotateImageRequest[]; } @@ -2125,7 +2125,7 @@ export namespace vision_v1p2beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -2151,7 +2151,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p2beta1ProductSearchParams { /** - * The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. + * The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied. */ boundingPoly?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2159,7 +2159,7 @@ export namespace vision_v1p2beta1 { */ filter?: string | null; /** - * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", or "toys-v2" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. + * The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well. */ productCategories?: string[] | null; /** @@ -3047,7 +3047,7 @@ export namespace vision_v1p2beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -3162,7 +3162,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$GoogleCloudVisionV1p3beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly[]; /** @@ -3170,7 +3170,7 @@ export namespace vision_v1p2beta1 { */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -3452,1064 +3452,79 @@ export namespace vision_v1p2beta1 { * If present, image properties were extracted successfully. */ imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p4beta1ImageProperties; - /** - * If present, image quality calculation has completed successfully. - */ - imageQualityAnnotation?: Schema$GoogleCloudVisionV1p4beta1ImageQuality; - /** - * If present, label detection has completed successfully. - */ - labelAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, landmark detection has completed successfully. - */ - landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. - */ - localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; - /** - * If present, logo detection has completed successfully. - */ - logoAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, product search has completed successfully. - */ - productSearchResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResults; - /** - * If present, image quality optimization has completed successfully. - */ - qualityOptimizationResult?: Schema$GoogleCloudVisionV1p4beta1QualityOptimizationResult; - /** - * If present, safe-search annotation has completed successfully. - */ - safeSearchAnnotation?: Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation; - /** - * If present, text (OCR) detection has completed successfully. - */ - textAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; - /** - * If present, web detection has completed successfully. - */ - webDetection?: Schema$GoogleCloudVisionV1p4beta1WebDetection; - } - /** - * The response for a single offline file annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse { - /** - * The output location and metadata from AsyncAnnotateFileRequest. - */ - outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; - } - /** - * Response to an async batch file annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { - /** - * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. - */ - responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; - } - /** - * Response to an async batch image annotation request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse { - /** - * The output location and metadata from AsyncBatchAnnotateImagesRequest. - */ - outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; - } - /** - * A list of file annotation responses. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { - /** - * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. - */ - responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; - } - /** - * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { - /** - * The time when the batch request is finished and google.longrunning.Operation.done is set to true. - */ - endTime?: string | null; - /** - * The current state of the batch operation. - */ - state?: string | null; - /** - * The time when the batch request was submitted to the server. - */ - submitTime?: string | null; - } - /** - * Logical element on the page. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Block { - /** - * Detected block type (text, image etc) for this block. - */ - blockType?: string | null; - /** - * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results on the block. Range [0, 1]. - */ - confidence?: number | null; - /** - * List of paragraphs in this block (if this blocks is of type text). - */ - paragraphs?: Schema$GoogleCloudVisionV1p4beta1Paragraph[]; - /** - * Additional information detected for the block. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1BoundingPoly { - /** - * The bounding polygon normalized vertices. - */ - normalizedVertices?: Schema$GoogleCloudVisionV1p4beta1NormalizedVertex[]; - /** - * The bounding polygon vertices. - */ - vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; - } - /** - * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { - /** - * RGB components of the color. - */ - color?: Schema$Color; - /** - * The fraction of pixels the color occupies in the image. Value in range [0, 1]. - */ - pixelFraction?: number | null; - /** - * Image-specific score for this color. Value in range [0, 1]. - */ - score?: number | null; - } - /** - * Single crop hint that is used to generate a new crop when serving an image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1CropHint { - /** - * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of this being a salient region. Range [0, 1]. - */ - confidence?: number | null; - /** - * Fraction of importance of this salient region with respect to the original image. - */ - importanceFraction?: number | null; - } - /** - * Set of crop hints that are used to generate new crops when serving images. - */ - export interface Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation { - /** - * Crop hint results. - */ - cropHints?: Schema$GoogleCloudVisionV1p4beta1CropHint[]; - } - /** - * Set of dominant colors and their corresponding scores. - */ - export interface Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation { - /** - * RGB color values with their score and pixel fraction. - */ - colors?: Schema$GoogleCloudVisionV1p4beta1ColorInfo[]; - } - /** - * Set of detected entity features. - */ - export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { - /** - * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. - */ - confidence?: number | null; - /** - * Entity textual description, expressed in its `locale` language. - */ - description?: string | null; - /** - * The language code for the locale in which the entity textual `description` is expressed. - */ - locale?: string | null; - /** - * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. - */ - locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; - /** - * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). - */ - mid?: string | null; - /** - * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. - */ - properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; - /** - * Overall score of the result. Range [0, 1]. - */ - score?: number | null; - /** - * The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]. - */ - topicality?: number | null; - } - /** - * A face annotation object contains the results of face detection. - */ - export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotation { - /** - * Anger likelihood. - */ - angerLikelihood?: string | null; - /** - * Blurred likelihood. - */ - blurredLikelihood?: string | null; - /** - * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Detection confidence. Range [0, 1]. - */ - detectionConfidence?: number | null; - /** - * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. - */ - fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Headwear likelihood. - */ - headwearLikelihood?: string | null; - /** - * Joy likelihood. - */ - joyLikelihood?: string | null; - /** - * Face landmarking confidence. Range [0, 1]. - */ - landmarkingConfidence?: number | null; - /** - * Detected face landmarks. - */ - landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; - /** - * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. - */ - panAngle?: number | null; - /** - * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]. - */ - rollAngle?: number | null; - /** - * Sorrow likelihood. - */ - sorrowLikelihood?: string | null; - /** - * Surprise likelihood. - */ - surpriseLikelihood?: string | null; - /** - * Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]. - */ - tiltAngle?: number | null; - /** - * Under-exposed likelihood. - */ - underExposedLikelihood?: string | null; - } - /** - * A face-specific landmark (for example, a face feature). - */ - export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { - /** - * Face landmark position. - */ - position?: Schema$GoogleCloudVisionV1p4beta1Position; - /** - * Face landmark type. - */ - type?: string | null; - } - /** - * The Google Cloud Storage location where the output will be written to. - */ - export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { - /** - * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. - */ - uri?: string | null; - } - /** - * The Google Cloud Storage location where the input will be read from. - */ - export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { - /** - * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. - */ - uri?: string | null; - } - /** - * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { - /** - * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. - */ - pageNumber?: number | null; - /** - * The URI of the file used to produce the image. - */ - uri?: string | null; - } - /** - * Stores image properties, such as dominant colors. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageProperties { - /** - * If present, dominant colors completed successfully. - */ - dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; - } - /** - * Stores image quality scores, could be aesthetic quality or technical quality. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImageQuality { - /** - * A score representing the aesthetic/technical quality of the image. The score is in range [0, 1]. Higher value corresponds to more professional looking photos. 0 means the image looks very bad, 1 means the image with very high quality. - */ - qualityScore?: number | null; - } - /** - * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { - /** - * The list of reference_images that are imported successfully. - */ - referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; - /** - * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. - */ - statuses?: Schema$Status[]; - } - /** - * The desired input location and metadata. - */ - export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { - /** - * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. - */ - content?: string | null; - /** - * The Google Cloud Storage location to read the input from. - */ - gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; - /** - * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. - */ - mimeType?: string | null; - } - /** - * Set of detected objects with bounding boxes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation { - /** - * Image region to which this object belongs. This must be populated. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - /** - * Object ID that should align with EntityAnnotation mid. - */ - mid?: string | null; - /** - * Object name, expressed in its `language_code` language. - */ - name?: string | null; - /** - * Score of the result. Range [0, 1]. - */ - score?: number | null; - } - /** - * Detected entity location information. - */ - export interface Schema$GoogleCloudVisionV1p4beta1LocationInfo { - /** - * lat/long location coordinates. - */ - latLng?: Schema$LatLng; - } - /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. - */ - export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - } - /** - * Contains metadata for the BatchAnnotateImages operation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1OperationMetadata { - /** - * The time when the batch request was received. - */ - createTime?: string | null; - /** - * Current state of the batch operation. - */ - state?: string | null; - /** - * The time when the operation result was last updated. - */ - updateTime?: string | null; - } - /** - * The desired output location and metadata. - */ - export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { - /** - * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. - */ - batchSize?: number | null; - /** - * The Google Cloud Storage location to write the output(s) to. - */ - gcsDestination?: Schema$GoogleCloudVisionV1p4beta1GcsDestination; - } - /** - * Detected page from OCR. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Page { - /** - * List of blocks of text, images etc on this page. - */ - blocks?: Schema$GoogleCloudVisionV1p4beta1Block[]; - /** - * Confidence of the OCR results on the page. Range [0, 1]. - */ - confidence?: number | null; - /** - * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. - */ - height?: number | null; - /** - * Additional information detected on the page. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. - */ - width?: number | null; - } - /** - * Structural unit of text representing a number of words in certain order. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { - /** - * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the paragraph. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the paragraph. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * List of all words in this paragraph. - */ - words?: Schema$GoogleCloudVisionV1p4beta1Word[]; - } - /** - * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Position { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - /** - * Z coordinate (or depth). - */ - z?: number | null; - } - /** - * A Product contains ReferenceImages. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Product { - /** - * User-provided metadata to be stored with this product. Must be at most 4096 characters long. - */ - description?: string | null; - /** - * The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. - */ - displayName?: string | null; - /** - * The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. - */ - name?: string | null; - /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. - */ - productCategory?: string | null; - /** - * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. - */ - productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; - } - /** - * A product label represented as a key-value pair. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { - /** - * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. - */ - key?: string | null; - /** - * The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. - */ - value?: string | null; - } - /** - * Results for a product search request. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { - /** - * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. - */ - indexTime?: string | null; - /** - * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. - */ - productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; - /** - * List of results, one for each product match. - */ - results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; - } - /** - * Information about the products similar to a single product in a query image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { - /** - * The bounding polygon around the product detected in the query image. - */ - boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * List of generic predictions for the object in the bounding box. - */ - objectAnnotations?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation[]; - /** - * List of results, one for each product match. - */ - results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; - } - /** - * Prediction for what the object in the bounding box is. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation { - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - /** - * Object ID that should align with EntityAnnotation mid. - */ - mid?: string | null; - /** - * Object name, expressed in its `language_code` language. - */ - name?: string | null; - /** - * Score of the result. Range [0, 1]. - */ - score?: number | null; - } - /** - * Information about a product. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { - /** - * The resource name of the image from the product that is the closest match to the query. - */ - image?: string | null; - /** - * The Product. - */ - product?: Schema$GoogleCloudVisionV1p4beta1Product; - /** - * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). - */ - score?: number | null; - } - /** - * A `Property` consists of a user-supplied name/value pair. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Property { - /** - * Name of the property. - */ - name?: string | null; - /** - * Value of numeric properties. - */ - uint64Value?: string | null; - /** - * Value of the property. - */ - value?: string | null; - } - /** - * Stores enhanced image bytes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1QualityOptimizationResult { - /** - * Optimized image bytes. - */ - image?: string | null; - /** - * Mime type of the output image. - */ - mimeType?: string | null; - /** - * Required optimization type. - */ - qualityOptimizationType?: string | null; - } - /** - * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. - */ - export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { - /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). - */ - boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; - /** - * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. - */ - name?: string | null; - /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. - */ - uri?: string | null; - } - /** - * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). - */ - export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { - /** - * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. - */ - adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; - /** - * Likelihood that this is a medical image. - */ - medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; - /** - * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. - */ - racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; - /** - * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. - */ - spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; - /** - * Likelihood that this image contains violent content. - */ - violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | null; - } - /** - * A single symbol representation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Symbol { - /** - * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the symbol. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the symbol. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * The actual UTF-8 representation of the symbol. - */ - text?: string | null; - } - /** - * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { - /** - * List of pages detected by OCR. - */ - pages?: Schema$GoogleCloudVisionV1p4beta1Page[]; - /** - * UTF-8 text detected on the pages. - */ - text?: string | null; - } - /** - * Detected start or end of a structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak { - /** - * True if break prepends the element. - */ - isPrefix?: boolean | null; - /** - * Detected break type. - */ - type?: string | null; - } - /** - * Detected language for a structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage { - /** - * Confidence of detected language. Range [0, 1]. - */ - confidence?: number | null; - /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - } - /** - * Additional information detected on the structural component. - */ - export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty { - /** - * Detected start or end of a text segment. - */ - detectedBreak?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; - } - /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Vertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate. - */ - y?: number | null; - } - /** - * Relevant information for the image from the Internet. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { - /** - * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. - */ - bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; - /** - * Fully matching images from the Internet. Can include resized copies of the query image. - */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Web pages containing the matching images from the Internet. - */ - pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; - /** - * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. - */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * The visually similar image results. - */ - visuallySimilarImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Deduced entities from similar images on the Internet. - */ - webEntities?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity[]; - } - /** - * Entity deduced from similar images on the Internet. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity { - /** - * Canonical description of the entity, in English. - */ - description?: string | null; - /** - * Opaque entity ID. - */ - entityId?: string | null; - /** - * Overall relevancy score for the entity. Not normalized and not comparable across different image queries. - */ - score?: number | null; - } - /** - * Metadata for online images. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage { - /** - * (Deprecated) Overall relevancy score for the image. - */ - score?: number | null; - /** - * The result image URL. - */ - url?: string | null; - } - /** - * Label to provide extra metadata for the web detection. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel { - /** - * Label for extra metadata. - */ - label?: string | null; - /** - * The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - */ - languageCode?: string | null; - } - /** - * Metadata for web pages. - */ - export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { - /** - * Fully matching images on the page. Can include resized copies of the query image. - */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * Title for the web page, may contain HTML markups. - */ - pageTitle?: string | null; - /** - * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. - */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; - /** - * (Deprecated) Overall relevancy score for the web page. - */ - score?: number | null; - /** - * The result web page URL. - */ - url?: string | null; - } - /** - * A word representation. - */ - export interface Schema$GoogleCloudVisionV1p4beta1Word { - /** - * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). - */ - boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; - /** - * Confidence of the OCR results for the word. Range [0, 1]. - */ - confidence?: number | null; - /** - * Additional information detected for the word. - */ - property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; - /** - * List of symbols in the word. The order of the symbols follows the natural reading order. - */ - symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; - } - /** - * Response to a single file annotation request. A file may contain one or more images, which individually have their own responses. - */ - export interface Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse { - /** - * If set, represents the error message for the failed request. The `responses` field will not be set in this case. - */ - error?: Schema$Status; - /** - * Information about the file for which this response is generated. - */ - inputConfig?: Schema$GoogleCloudVisionV1p5beta1InputConfig; - /** - * Individual responses to images found within the file. This field will be empty if the `error` field is set. - */ - responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse[]; - /** - * This field gives the total number of pages in the file. - */ - totalPages?: number | null; - } - /** - * Response to an image annotation request. - */ - export interface Schema$GoogleCloudVisionV1p5beta1AnnotateImageResponse { - /** - * If present, contextual information is needed to understand where this image comes from. - */ - context?: Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext; - /** - * If present, crop hints have completed successfully. - */ - cropHintsAnnotation?: Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation; - /** - * If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set. - */ - error?: Schema$Status; - /** - * If present, face detection has completed successfully. - */ - faceAnnotations?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotation[]; - /** - * If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text. - */ - fullTextAnnotation?: Schema$GoogleCloudVisionV1p5beta1TextAnnotation; - /** - * If present, image properties were extracted successfully. - */ - imagePropertiesAnnotation?: Schema$GoogleCloudVisionV1p5beta1ImageProperties; /** * If present, label detection has completed successfully. */ - labelAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + labelAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, landmark detection has completed successfully. */ - landmarkAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + landmarkAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, localized object detection has completed successfully. This will be sorted descending by confidence score. */ - localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation[]; + localizedObjectAnnotations?: Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation[]; /** * If present, logo detection has completed successfully. */ - logoAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + logoAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, product search has completed successfully. */ - productSearchResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResults; + productSearchResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResults; /** * If present, safe-search annotation has completed successfully. */ - safeSearchAnnotation?: Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation; + safeSearchAnnotation?: Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation; /** * If present, text (OCR) detection has completed successfully. */ - textAnnotations?: Schema$GoogleCloudVisionV1p5beta1EntityAnnotation[]; + textAnnotations?: Schema$GoogleCloudVisionV1p4beta1EntityAnnotation[]; /** * If present, web detection has completed successfully. */ - webDetection?: Schema$GoogleCloudVisionV1p5beta1WebDetection; + webDetection?: Schema$GoogleCloudVisionV1p4beta1WebDetection; } /** * The response for a single offline file annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse { /** * The output location and metadata from AsyncAnnotateFileRequest. */ - outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; + outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; } /** * Response to an async batch file annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateFilesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse { /** * The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest. */ - responses?: Schema$GoogleCloudVisionV1p5beta1AsyncAnnotateFileResponse[]; + responses?: Schema$GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse[]; } /** * Response to an async batch image annotation request. */ - export interface Schema$GoogleCloudVisionV1p5beta1AsyncBatchAnnotateImagesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse { /** * The output location and metadata from AsyncBatchAnnotateImagesRequest. */ - outputConfig?: Schema$GoogleCloudVisionV1p5beta1OutputConfig; + outputConfig?: Schema$GoogleCloudVisionV1p4beta1OutputConfig; } /** * A list of file annotation responses. */ - export interface Schema$GoogleCloudVisionV1p5beta1BatchAnnotateFilesResponse { + export interface Schema$GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse { /** * The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest. */ - responses?: Schema$GoogleCloudVisionV1p5beta1AnnotateFileResponse[]; + responses?: Schema$GoogleCloudVisionV1p4beta1AnnotateFileResponse[]; } /** * Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service. */ - export interface Schema$GoogleCloudVisionV1p5beta1BatchOperationMetadata { + export interface Schema$GoogleCloudVisionV1p4beta1BatchOperationMetadata { /** * The time when the batch request is finished and google.longrunning.Operation.done is set to true. */ @@ -4526,7 +3541,7 @@ export namespace vision_v1p2beta1 { /** * Logical element on the page. */ - export interface Schema$GoogleCloudVisionV1p5beta1Block { + export interface Schema$GoogleCloudVisionV1p4beta1Block { /** * Detected block type (text, image etc) for this block. */ @@ -4534,49 +3549,37 @@ export namespace vision_v1p2beta1 { /** * The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results on the block. Range [0, 1]. */ confidence?: number | null; - /** - * Detected pair for KEY_VALUE_PAIR block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. - */ - keyValuePair?: Schema$GoogleCloudVisionV1p5beta1KeyValuePair; - /** - * All UTF-8 text detected in this block. This field is by default not returned unless specified in TextDetectionParams.block_filter or DocumentParsingParams.block_filter. - */ - mergedText?: string | null; /** * List of paragraphs in this block (if this blocks is of type text). */ - paragraphs?: Schema$GoogleCloudVisionV1p5beta1Paragraph[]; + paragraphs?: Schema$GoogleCloudVisionV1p4beta1Paragraph[]; /** * Additional information detected for the block. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; - /** - * Detected table for TABLE block_type. This detection can be turned off by explicitly setting desired fields in DocumentParsingParams.block_filter. - */ - table?: Schema$GoogleCloudVisionV1p5beta1Table; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; } /** * A bounding polygon for the detected image annotation. */ - export interface Schema$GoogleCloudVisionV1p5beta1BoundingPoly { + export interface Schema$GoogleCloudVisionV1p4beta1BoundingPoly { /** * The bounding polygon normalized vertices. */ - normalizedVertices?: Schema$GoogleCloudVisionV1p5beta1NormalizedVertex[]; + normalizedVertices?: Schema$GoogleCloudVisionV1p4beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ - vertices?: Schema$GoogleCloudVisionV1p5beta1Vertex[]; + vertices?: Schema$GoogleCloudVisionV1p4beta1Vertex[]; } /** * Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ColorInfo { + export interface Schema$GoogleCloudVisionV1p4beta1ColorInfo { /** * RGB components of the color. */ @@ -4593,11 +3596,11 @@ export namespace vision_v1p2beta1 { /** * Single crop hint that is used to generate a new crop when serving an image. */ - export interface Schema$GoogleCloudVisionV1p5beta1CropHint { + export interface Schema$GoogleCloudVisionV1p4beta1CropHint { /** * The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of this being a salient region. Range [0, 1]. */ @@ -4610,29 +3613,29 @@ export namespace vision_v1p2beta1 { /** * Set of crop hints that are used to generate new crops when serving images. */ - export interface Schema$GoogleCloudVisionV1p5beta1CropHintsAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1CropHintsAnnotation { /** * Crop hint results. */ - cropHints?: Schema$GoogleCloudVisionV1p5beta1CropHint[]; + cropHints?: Schema$GoogleCloudVisionV1p4beta1CropHint[]; } /** * Set of dominant colors and their corresponding scores. */ - export interface Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation { /** * RGB color values with their score and pixel fraction. */ - colors?: Schema$GoogleCloudVisionV1p5beta1ColorInfo[]; + colors?: Schema$GoogleCloudVisionV1p4beta1ColorInfo[]; } /** * Set of detected entity features. */ - export interface Schema$GoogleCloudVisionV1p5beta1EntityAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1EntityAnnotation { /** * Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * **Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1]. */ @@ -4648,7 +3651,7 @@ export namespace vision_v1p2beta1 { /** * The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks. */ - locations?: Schema$GoogleCloudVisionV1p5beta1LocationInfo[]; + locations?: Schema$GoogleCloudVisionV1p4beta1LocationInfo[]; /** * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/). */ @@ -4656,7 +3659,7 @@ export namespace vision_v1p2beta1 { /** * Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity. */ - properties?: Schema$GoogleCloudVisionV1p5beta1Property[]; + properties?: Schema$GoogleCloudVisionV1p4beta1Property[]; /** * Overall score of the result. Range [0, 1]. */ @@ -4669,7 +3672,7 @@ export namespace vision_v1p2beta1 { /** * A face annotation object contains the results of face detection. */ - export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotation { /** * Anger likelihood. */ @@ -4681,7 +3684,7 @@ export namespace vision_v1p2beta1 { /** * The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to "frame" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Detection confidence. Range [0, 1]. */ @@ -4689,7 +3692,7 @@ export namespace vision_v1p2beta1 { /** * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the <code>fd</code> (face detection) prefix. */ - fdBoundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + fdBoundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Headwear likelihood. */ @@ -4705,7 +3708,7 @@ export namespace vision_v1p2beta1 { /** * Detected face landmarks. */ - landmarks?: Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark[]; + landmarks?: Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark[]; /** * Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]. */ @@ -4734,11 +3737,11 @@ export namespace vision_v1p2beta1 { /** * A face-specific landmark (for example, a face feature). */ - export interface Schema$GoogleCloudVisionV1p5beta1FaceAnnotationLandmark { + export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { /** * Face landmark position. */ - position?: Schema$GoogleCloudVisionV1p5beta1Position; + position?: Schema$GoogleCloudVisionV1p4beta1Position; /** * Face landmark type. */ @@ -4747,7 +3750,7 @@ export namespace vision_v1p2beta1 { /** * The Google Cloud Storage location where the output will be written to. */ - export interface Schema$GoogleCloudVisionV1p5beta1GcsDestination { + export interface Schema$GoogleCloudVisionV1p4beta1GcsDestination { /** * Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files. */ @@ -4756,7 +3759,7 @@ export namespace vision_v1p2beta1 { /** * The Google Cloud Storage location where the input will be read from. */ - export interface Schema$GoogleCloudVisionV1p5beta1GcsSource { + export interface Schema$GoogleCloudVisionV1p4beta1GcsSource { /** * Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported. */ @@ -4765,7 +3768,7 @@ export namespace vision_v1p2beta1 { /** * If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImageAnnotationContext { + export interface Schema$GoogleCloudVisionV1p4beta1ImageAnnotationContext { /** * If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image. */ @@ -4778,20 +3781,20 @@ export namespace vision_v1p2beta1 { /** * Stores image properties, such as dominant colors. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImageProperties { + export interface Schema$GoogleCloudVisionV1p4beta1ImageProperties { /** * If present, dominant colors completed successfully. */ - dominantColors?: Schema$GoogleCloudVisionV1p5beta1DominantColorsAnnotation; + dominantColors?: Schema$GoogleCloudVisionV1p4beta1DominantColorsAnnotation; } /** * Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field. */ - export interface Schema$GoogleCloudVisionV1p5beta1ImportProductSetsResponse { + export interface Schema$GoogleCloudVisionV1p4beta1ImportProductSetsResponse { /** * The list of reference_images that are imported successfully. */ - referenceImages?: Schema$GoogleCloudVisionV1p5beta1ReferenceImage[]; + referenceImages?: Schema$GoogleCloudVisionV1p4beta1ReferenceImage[]; /** * The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0. */ @@ -4800,7 +3803,7 @@ export namespace vision_v1p2beta1 { /** * The desired input location and metadata. */ - export interface Schema$GoogleCloudVisionV1p5beta1InputConfig { + export interface Schema$GoogleCloudVisionV1p4beta1InputConfig { /** * File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests. */ @@ -4808,45 +3811,20 @@ export namespace vision_v1p2beta1 { /** * The Google Cloud Storage location to read the input from. */ - gcsSource?: Schema$GoogleCloudVisionV1p5beta1GcsSource; + gcsSource?: Schema$GoogleCloudVisionV1p4beta1GcsSource; /** * The type of the file. Currently only "application/pdf", "image/tiff" and "image/gif" are supported. Wildcards are not supported. */ mimeType?: string | null; } - /** - * Proto for a key value pair. - */ - export interface Schema$GoogleCloudVisionV1p5beta1KeyValuePair { - /** - * The key string value. - */ - key?: string | null; - /** - * Key block of the pair containing the normalized bounding box and key text. - */ - keyBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - /** - * Optional. The translation of key text if the text is not in English. - */ - normalizedKey?: string | null; - /** - * Value block of the pair containing the normalized bounding box and value text, including potentially deeper structures within the value text. - */ - valueBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - /** - * Type of the value. Valid strings are the following: "generic" - For generic text that is mapped to a value. "number" - for numeric types "id" - for generic identifiers. "currency" - for currency values. "date" - for dates. "time" - for time and duration values. "date_range" - for date ranges. "address" - for address values (can be long). "person" - for names of people or other personal identifiers. "phone" - for phone numbers. - */ - valueType?: string | null; - } /** * Set of detected objects with bounding boxes. */ - export interface Schema$GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation { /** * Image region to which this object belongs. This must be populated. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ @@ -4867,7 +3845,7 @@ export namespace vision_v1p2beta1 { /** * Detected entity location information. */ - export interface Schema$GoogleCloudVisionV1p5beta1LocationInfo { + export interface Schema$GoogleCloudVisionV1p4beta1LocationInfo { /** * lat/long location coordinates. */ @@ -4876,7 +3854,7 @@ export namespace vision_v1p2beta1 { /** * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ - export interface Schema$GoogleCloudVisionV1p5beta1NormalizedVertex { + export interface Schema$GoogleCloudVisionV1p4beta1NormalizedVertex { /** * X coordinate. */ @@ -4889,7 +3867,7 @@ export namespace vision_v1p2beta1 { /** * Contains metadata for the BatchAnnotateImages operation. */ - export interface Schema$GoogleCloudVisionV1p5beta1OperationMetadata { + export interface Schema$GoogleCloudVisionV1p4beta1OperationMetadata { /** * The time when the batch request was received. */ @@ -4906,7 +3884,7 @@ export namespace vision_v1p2beta1 { /** * The desired output location and metadata. */ - export interface Schema$GoogleCloudVisionV1p5beta1OutputConfig { + export interface Schema$GoogleCloudVisionV1p4beta1OutputConfig { /** * The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations. */ @@ -4914,16 +3892,16 @@ export namespace vision_v1p2beta1 { /** * The Google Cloud Storage location to write the output(s) to. */ - gcsDestination?: Schema$GoogleCloudVisionV1p5beta1GcsDestination; + gcsDestination?: Schema$GoogleCloudVisionV1p4beta1GcsDestination; } /** * Detected page from OCR. */ - export interface Schema$GoogleCloudVisionV1p5beta1Page { + export interface Schema$GoogleCloudVisionV1p4beta1Page { /** * List of blocks of text, images etc on this page. */ - blocks?: Schema$GoogleCloudVisionV1p5beta1Block[]; + blocks?: Schema$GoogleCloudVisionV1p4beta1Block[]; /** * Confidence of the OCR results on the page. Range [0, 1]. */ @@ -4932,14 +3910,10 @@ export namespace vision_v1p2beta1 { * Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ height?: number | null; - /** - * All UTF-8 text detected in this page. This field is by default not returned unless specified in TextDetectionParams.page_filter. - */ - mergedText?: string | null; /** * Additional information detected on the page. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels. */ @@ -4948,32 +3922,28 @@ export namespace vision_v1p2beta1 { /** * Structural unit of text representing a number of words in certain order. */ - export interface Schema$GoogleCloudVisionV1p5beta1Paragraph { + export interface Schema$GoogleCloudVisionV1p4beta1Paragraph { /** * The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the paragraph. Range [0, 1]. */ confidence?: number | null; - /** - * All UTF-8 text detected in this paragraph. This field is by default not returned unless specified in TextDetectionParams.paragraph_filter. - */ - mergedText?: string | null; /** * Additional information detected for the paragraph. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * List of all words in this paragraph. */ - words?: Schema$GoogleCloudVisionV1p5beta1Word[]; + words?: Schema$GoogleCloudVisionV1p4beta1Word[]; } /** * A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image. */ - export interface Schema$GoogleCloudVisionV1p5beta1Position { + export interface Schema$GoogleCloudVisionV1p4beta1Position { /** * X coordinate. */ @@ -4990,7 +3960,7 @@ export namespace vision_v1p2beta1 { /** * A Product contains ReferenceImages. */ - export interface Schema$GoogleCloudVisionV1p5beta1Product { + export interface Schema$GoogleCloudVisionV1p4beta1Product { /** * User-provided metadata to be stored with this product. Must be at most 4096 characters long. */ @@ -5004,18 +3974,18 @@ export namespace vision_v1p2beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** * Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. */ - productLabels?: Schema$GoogleCloudVisionV1p5beta1ProductKeyValue[]; + productLabels?: Schema$GoogleCloudVisionV1p4beta1ProductKeyValue[]; } /** * A product label represented as a key-value pair. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductKeyValue { + export interface Schema$GoogleCloudVisionV1p4beta1ProductKeyValue { /** * The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes. */ @@ -5028,7 +3998,7 @@ export namespace vision_v1p2beta1 { /** * Results for a product search request. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResults { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResults { /** * Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results. */ @@ -5036,33 +4006,33 @@ export namespace vision_v1p2beta1 { /** * List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results. */ - productGroupedResults?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult[]; + productGroupedResults?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult[]; /** * List of results, one for each product match. */ - results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** * Information about the products similar to a single product in a query image. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsGroupedResult { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult { /** * The bounding polygon around the product detected in the query image. */ - boundingPoly?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingPoly?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * List of generic predictions for the object in the bounding box. */ - objectAnnotations?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsObjectAnnotation[]; + objectAnnotations?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation[]; /** * List of results, one for each product match. */ - results?: Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult[]; + results?: Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult[]; } /** * Prediction for what the object in the bounding box is. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsObjectAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation { /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */ @@ -5083,7 +4053,7 @@ export namespace vision_v1p2beta1 { /** * Information about a product. */ - export interface Schema$GoogleCloudVisionV1p5beta1ProductSearchResultsResult { + export interface Schema$GoogleCloudVisionV1p4beta1ProductSearchResultsResult { /** * The resource name of the image from the product that is the closest match to the query. */ @@ -5091,7 +4061,7 @@ export namespace vision_v1p2beta1 { /** * The Product. */ - product?: Schema$GoogleCloudVisionV1p5beta1Product; + product?: Schema$GoogleCloudVisionV1p4beta1Product; /** * A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence). */ @@ -5100,7 +4070,7 @@ export namespace vision_v1p2beta1 { /** * A `Property` consists of a user-supplied name/value pair. */ - export interface Schema$GoogleCloudVisionV1p5beta1Property { + export interface Schema$GoogleCloudVisionV1p4beta1Property { /** * Name of the property. */ @@ -5117,77 +4087,53 @@ export namespace vision_v1p2beta1 { /** * A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes. */ - export interface Schema$GoogleCloudVisionV1p5beta1ReferenceImage { + export interface Schema$GoogleCloudVisionV1p4beta1ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ - boundingPolys?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly[]; + boundingPolys?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly[]; /** * The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } /** * Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). */ - export interface Schema$GoogleCloudVisionV1p5beta1SafeSearchAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1SafeSearchAnnotation { /** * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | null; } /** * A single symbol representation. */ - export interface Schema$GoogleCloudVisionV1p5beta1Symbol { + export interface Schema$GoogleCloudVisionV1p4beta1Symbol { /** * The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the symbol. Range [0, 1]. */ @@ -5195,63 +4141,20 @@ export namespace vision_v1p2beta1 { /** * Additional information detected for the symbol. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * The actual UTF-8 representation of the symbol. */ text?: string | null; } - /** - * A table representation similar to HTML table structure. - */ - export interface Schema$GoogleCloudVisionV1p5beta1Table { - /** - * Body rows of the table - */ - bodyRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; - /** - * Header rows of the table - */ - headerRows?: Schema$GoogleCloudVisionV1p5beta1TableTableRow[]; - } - /** - * A cell representation inside of tables. - */ - export interface Schema$GoogleCloudVisionV1p5beta1TableTableCell { - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - /** - * The merged text value of this cell, omitting any deeper structural information unlike `text_block`. This is useful for simple cells. - */ - text?: string | null; - /** - * Text block for this cell which also contains the normalized bounding box for the cell and deeper structures within a cell if present. - */ - textBlock?: Schema$GoogleCloudVisionV1p5beta1Block; - } - /** - * A row of table cells. - */ - export interface Schema$GoogleCloudVisionV1p5beta1TableTableRow { - /** - * Cells that make up this row. - */ - cells?: Schema$GoogleCloudVisionV1p5beta1TableTableCell[]; - } /** * TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotation { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotation { /** * List of pages detected by OCR. */ - pages?: Schema$GoogleCloudVisionV1p5beta1Page[]; + pages?: Schema$GoogleCloudVisionV1p4beta1Page[]; /** * UTF-8 text detected on the pages. */ @@ -5260,7 +4163,7 @@ export namespace vision_v1p2beta1 { /** * Detected start or end of a structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak { /** * True if break prepends the element. */ @@ -5273,7 +4176,7 @@ export namespace vision_v1p2beta1 { /** * Detected language for a structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage { /** * Confidence of detected language. Range [0, 1]. */ @@ -5286,20 +4189,20 @@ export namespace vision_v1p2beta1 { /** * Additional information detected on the structural component. */ - export interface Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty { + export interface Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty { /** * Detected start or end of a text segment. */ - detectedBreak?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedBreak; + detectedBreak?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak; /** * A list of detected languages together with confidence. */ - detectedLanguages?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationDetectedLanguage[]; + detectedLanguages?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage[]; } /** * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. */ - export interface Schema$GoogleCloudVisionV1p5beta1Vertex { + export interface Schema$GoogleCloudVisionV1p4beta1Vertex { /** * X coordinate. */ @@ -5312,36 +4215,36 @@ export namespace vision_v1p2beta1 { /** * Relevant information for the image from the Internet. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetection { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetection { /** * The service's best guess as to the topic of the request image. Inferred from similar images on the open web. */ - bestGuessLabels?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel[]; + bestGuessLabels?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel[]; /** * Fully matching images from the Internet. Can include resized copies of the query image. */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Web pages containing the matching images from the Internet. */ - pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage[]; + pagesWithMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage[]; /** * Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * The visually similar image results. */ - visuallySimilarImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + visuallySimilarImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Deduced entities from similar images on the Internet. */ - webEntities?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity[]; + webEntities?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity[]; } /** * Entity deduced from similar images on the Internet. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebEntity { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebEntity { /** * Canonical description of the entity, in English. */ @@ -5358,7 +4261,7 @@ export namespace vision_v1p2beta1 { /** * Metadata for online images. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage { /** * (Deprecated) Overall relevancy score for the image. */ @@ -5371,7 +4274,7 @@ export namespace vision_v1p2beta1 { /** * Label to provide extra metadata for the web detection. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebLabel { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebLabel { /** * Label for extra metadata. */ @@ -5384,11 +4287,11 @@ export namespace vision_v1p2beta1 { /** * Metadata for web pages. */ - export interface Schema$GoogleCloudVisionV1p5beta1WebDetectionWebPage { + export interface Schema$GoogleCloudVisionV1p4beta1WebDetectionWebPage { /** * Fully matching images on the page. Can include resized copies of the query image. */ - fullMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + fullMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * Title for the web page, may contain HTML markups. */ @@ -5396,7 +4299,7 @@ export namespace vision_v1p2beta1 { /** * Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops. */ - partialMatchingImages?: Schema$GoogleCloudVisionV1p5beta1WebDetectionWebImage[]; + partialMatchingImages?: Schema$GoogleCloudVisionV1p4beta1WebDetectionWebImage[]; /** * (Deprecated) Overall relevancy score for the web page. */ @@ -5409,27 +4312,23 @@ export namespace vision_v1p2beta1 { /** * A word representation. */ - export interface Schema$GoogleCloudVisionV1p5beta1Word { + export interface Schema$GoogleCloudVisionV1p4beta1Word { /** * The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). */ - boundingBox?: Schema$GoogleCloudVisionV1p5beta1BoundingPoly; + boundingBox?: Schema$GoogleCloudVisionV1p4beta1BoundingPoly; /** * Confidence of the OCR results for the word. Range [0, 1]. */ confidence?: number | null; - /** - * All UTF-8 text detected in this word. This field is by default not returned unless specified in TextDetectionParams.word_filter. - */ - mergedText?: string | null; /** * Additional information detected for the word. */ - property?: Schema$GoogleCloudVisionV1p5beta1TextAnnotationTextProperty; + property?: Schema$GoogleCloudVisionV1p4beta1TextAnnotationTextProperty; /** * List of symbols in the word. The order of the symbols follows the natural reading order. */ - symbols?: Schema$GoogleCloudVisionV1p5beta1Symbol[]; + symbols?: Schema$GoogleCloudVisionV1p4beta1Symbol[]; } /** * Information about the products similar to a single product in a query image. @@ -5742,7 +4641,7 @@ export namespace vision_v1p2beta1 { */ name?: string | null; /** - * The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable. + * Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. */ productCategory?: string | null; /** @@ -5789,7 +4688,7 @@ export namespace vision_v1p2beta1 { */ export interface Schema$ReferenceImage { /** - * Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). + * Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). */ boundingPolys?: Schema$BoundingPoly[]; /** @@ -5797,7 +4696,7 @@ export namespace vision_v1p2beta1 { */ name?: string | null; /** - * The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. Required. + * Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. */ uri?: string | null; } @@ -5826,46 +4725,22 @@ export namespace vision_v1p2beta1 { * Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities. */ adult?: string | null; - /** - * Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - adultConfidence?: number | null; /** * Likelihood that this is a medical image. */ medical?: string | null; - /** - * Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - medicalConfidence?: number | null; - /** - * Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - nsfwConfidence?: number | null; /** * Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas. */ racy?: string | null; - /** - * Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - racyConfidence?: number | null; /** * Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive. */ spoof?: string | null; - /** - * Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - spoofConfidence?: number | null; /** * Likelihood that this image contains violent content. */ violence?: string | null; - /** - * Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident. - */ - violenceConfidence?: number | 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). diff --git a/src/apis/websecurityscanner/v1alpha.ts b/src/apis/websecurityscanner/v1alpha.ts index a85f3c48061..f3c05175bec 100644 --- a/src/apis/websecurityscanner/v1alpha.ts +++ b/src/apis/websecurityscanner/v1alpha.ts @@ -173,63 +173,63 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$Finding { /** - * Output only. The body of the request that triggered the vulnerability. + * The body of the request that triggered the vulnerability. */ body?: string | null; /** - * Output only. The description of the vulnerability. + * The description of the vulnerability. */ description?: string | null; /** - * Output only. The URL where the browser lands when the vulnerability is detected. + * The URL where the browser lands when the vulnerability is detected. */ finalUrl?: string | null; /** - * Output only. The type of the Finding. + * The type of the Finding. */ findingType?: string | null; /** - * Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. + * If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */ frameUrl?: string | null; /** - * Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. + * The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */ fuzzedUrl?: string | null; /** - * Output only. The http method of the request that triggered the vulnerability, in uppercase. + * The http method of the request that triggered the vulnerability, in uppercase. */ httpMethod?: string | null; /** - * Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. + * The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. */ name?: string | null; /** - * Output only. An addon containing information about outdated libraries. + * An addon containing information about outdated libraries. */ outdatedLibrary?: Schema$OutdatedLibrary; /** - * Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. + * The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ reproductionUrl?: string | null; /** - * Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. + * The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ trackingId?: string | null; /** - * Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. + * An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ violatingResource?: Schema$ViolatingResource; /** - * Output only. An addon containing information about vulnerable or missing HTTP headers. + * An addon containing information about vulnerable or missing HTTP headers. */ vulnerableHeaders?: Schema$VulnerableHeaders; /** - * Output only. An addon containing information about request parameters which were found to be vulnerable. + * An addon containing information about request parameters which were found to be vulnerable. */ vulnerableParameters?: Schema$VulnerableParameters; /** - * Output only. An addon containing information reported for an XSS, if any. + * An addon containing information reported for an XSS, if any. */ xss?: Schema$Xss; } @@ -238,11 +238,11 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$FindingTypeStats { /** - * Output only. The count of findings belonging to this finding type. + * The count of findings belonging to this finding type. */ findingCount?: number | null; /** - * Output only. The finding type associated with the stats. + * The finding type associated with the stats. */ findingType?: string | null; } @@ -400,39 +400,39 @@ export namespace websecurityscanner_v1alpha { */ export interface Schema$ScanRun { /** - * Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. + * The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */ endTime?: string | null; /** - * Output only. The execution state of the ScanRun. + * The execution state of the ScanRun. */ executionState?: string | null; /** - * Output only. Whether the scan run has found any vulnerabilities. + * Whether the scan run has found any vulnerabilities. */ hasVulnerabilities?: boolean | null; /** - * Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. + * The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */ name?: string | null; /** - * Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. + * The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */ progressPercent?: number | null; /** - * Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". + * The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */ resultState?: string | null; /** - * Output only. The time at which the ScanRun started. + * The time at which the ScanRun started. */ startTime?: string | null; /** - * Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. + * The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */ urlsCrawledCount?: string | null; /** - * Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. + * The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. */ urlsTestedCount?: string | null; } @@ -1551,7 +1551,7 @@ export namespace websecurityscanner_v1alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * @param {string=} params.filter Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * @param {integer=} params.pageSize The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * @param {string=} params.pageToken A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * @param {string} params.parent Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. @@ -1645,7 +1645,7 @@ export namespace websecurityscanner_v1alpha { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */ filter?: string; /** diff --git a/src/apis/websecurityscanner/v1beta.ts b/src/apis/websecurityscanner/v1beta.ts index 0d56285055f..dd964c45f29 100644 --- a/src/apis/websecurityscanner/v1beta.ts +++ b/src/apis/websecurityscanner/v1beta.ts @@ -135,15 +135,15 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$CrawledUrl { /** - * Output only. The body of the request that was used to visit the URL. + * The body of the request that was used to visit the URL. */ body?: string | null; /** - * Output only. The http method of the request that was used to visit the URL, in uppercase. + * The http method of the request that was used to visit the URL, in uppercase. */ httpMethod?: string | null; /** - * Output only. The URL that was crawled. + * The URL that was crawled. */ url?: string | null; } @@ -173,67 +173,67 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$Finding { /** - * Output only. The body of the request that triggered the vulnerability. + * The body of the request that triggered the vulnerability. */ body?: string | null; /** - * Output only. The description of the vulnerability. + * The description of the vulnerability. */ description?: string | null; /** - * Output only. The URL where the browser lands when the vulnerability is detected. + * The URL where the browser lands when the vulnerability is detected. */ finalUrl?: string | null; /** - * Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-scanner/docs/scan-result-details + * The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-scanner/docs/scan-result-details */ findingType?: string | null; /** - * Output only. An addon containing information reported for a vulnerability with an HTML form, if any. + * An addon containing information reported for a vulnerability with an HTML form, if any. */ form?: Schema$Form; /** - * Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. + * If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. */ frameUrl?: string | null; /** - * Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. + * The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. */ fuzzedUrl?: string | null; /** - * Output only. The http method of the request that triggered the vulnerability, in uppercase. + * The http method of the request that triggered the vulnerability, in uppercase. */ httpMethod?: string | null; /** - * Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. + * The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. */ name?: string | null; /** - * Output only. An addon containing information about outdated libraries. + * An addon containing information about outdated libraries. */ outdatedLibrary?: Schema$OutdatedLibrary; /** - * Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. + * The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ reproductionUrl?: string | null; /** - * Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. + * The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ trackingId?: string | null; /** - * Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. + * An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. */ violatingResource?: Schema$ViolatingResource; /** - * Output only. An addon containing information about vulnerable or missing HTTP headers. + * An addon containing information about vulnerable or missing HTTP headers. */ vulnerableHeaders?: Schema$VulnerableHeaders; /** - * Output only. An addon containing information about request parameters which were found to be vulnerable. + * An addon containing information about request parameters which were found to be vulnerable. */ vulnerableParameters?: Schema$VulnerableParameters; /** - * Output only. An addon containing information reported for an XSS, if any. + * An addon containing information reported for an XSS, if any. */ xss?: Schema$Xss; } @@ -242,11 +242,11 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$FindingTypeStats { /** - * Output only. The count of findings belonging to this finding type. + * The count of findings belonging to this finding type. */ findingCount?: number | null; /** - * Output only. The finding type associated with the stats. + * The finding type associated with the stats. */ findingType?: string | null; } @@ -425,11 +425,11 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$ScanConfigError { /** - * Output only. Indicates the reason code for a configuration failure. + * Indicates the reason code for a configuration failure. */ code?: string | null; /** - * Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. + * Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. */ fieldName?: string | null; } @@ -438,47 +438,47 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$ScanRun { /** - * Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. + * The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. */ endTime?: string | null; /** - * Output only. If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. + * If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available. */ errorTrace?: Schema$ScanRunErrorTrace; /** - * Output only. The execution state of the ScanRun. + * The execution state of the ScanRun. */ executionState?: string | null; /** - * Output only. Whether the scan run has found any vulnerabilities. + * Whether the scan run has found any vulnerabilities. */ hasVulnerabilities?: boolean | null; /** - * Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. + * The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. */ name?: string | null; /** - * Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. + * The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. */ progressPercent?: number | null; /** - * Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". + * The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". */ resultState?: string | null; /** - * Output only. The time at which the ScanRun started. + * The time at which the ScanRun started. */ startTime?: string | null; /** - * Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. + * The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. */ urlsCrawledCount?: string | null; /** - * Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. + * The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. */ urlsTestedCount?: string | null; /** - * Output only. A list of warnings, if such are encountered during this scan run. + * A list of warnings, if such are encountered during this scan run. */ warningTraces?: Schema$ScanRunWarningTrace[]; } @@ -487,15 +487,15 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$ScanRunErrorTrace { /** - * Output only. Indicates the error reason code. + * Indicates the error reason code. */ code?: string | null; /** - * Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. + * If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses. */ mostCommonHttpErrorCode?: number | null; /** - * Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. + * If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run. */ scanConfigError?: Schema$ScanConfigError; } @@ -504,7 +504,7 @@ export namespace websecurityscanner_v1beta { */ export interface Schema$ScanRunWarningTrace { /** - * Output only. Indicates the warning code. + * Indicates the warning code. */ code?: string | null; } @@ -1623,7 +1623,7 @@ export namespace websecurityscanner_v1beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * @param {string=} params.filter Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * @param {integer=} params.pageSize The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * @param {string=} params.pageToken A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. * @param {string} params.parent Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. @@ -1717,7 +1717,7 @@ export namespace websecurityscanner_v1beta { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. + * Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. */ filter?: string; /** diff --git a/src/index.ts b/src/index.ts index 04594620e68..59d1dc088bb 100644 --- a/src/index.ts +++ b/src/index.ts @@ -59,6 +59,7 @@ export {bigqueryreservation_v1} from './apis/bigqueryreservation/v1'; export { bigqueryreservation_v1alpha2, } from './apis/bigqueryreservation/v1alpha2'; +export {bigqueryreservation_v1beta1} from './apis/bigqueryreservation/v1beta1'; export {bigtableadmin_v1} from './apis/bigtableadmin/v1'; export {bigtableadmin_v2} from './apis/bigtableadmin/v2'; export {binaryauthorization_v1} from './apis/binaryauthorization/v1'; @@ -129,8 +130,6 @@ export {datastore_v1beta3} from './apis/datastore/v1beta3'; export {deploymentmanager_alpha} from './apis/deploymentmanager/alpha'; export {deploymentmanager_v2} from './apis/deploymentmanager/v2'; export {deploymentmanager_v2beta} from './apis/deploymentmanager/v2beta'; -export {dfareporting_v3_1} from './apis/dfareporting/v3.1'; -export {dfareporting_v3_2} from './apis/dfareporting/v3.2'; export {dfareporting_v3_3} from './apis/dfareporting/v3.3'; export {dialogflow_v2} from './apis/dialogflow/v2'; export {dialogflow_v2beta1} from './apis/dialogflow/v2beta1'; @@ -191,10 +190,12 @@ export {language_v1beta1} from './apis/language/v1beta1'; export {language_v1beta2} from './apis/language/v1beta2'; export {libraryagent_v1} from './apis/libraryagent/v1'; export {licensing_v1} from './apis/licensing/v1'; +export {lifesciences_v2beta} from './apis/lifesciences/v2beta'; export {logging_v2} from './apis/logging/v2'; export {manufacturers_v1} from './apis/manufacturers/v1'; export {mirror_v1} from './apis/mirror/v1'; export {ml_v1} from './apis/ml/v1'; +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'; @@ -209,11 +210,13 @@ 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_v1beta} from './apis/policytroubleshooter/v1beta'; export {poly_v1} from './apis/poly/v1'; export {proximitybeacon_v1beta1} from './apis/proximitybeacon/v1beta1'; export {pubsub_v1} from './apis/pubsub/v1'; export {pubsub_v1beta1a} from './apis/pubsub/v1beta1a'; export {pubsub_v1beta2} from './apis/pubsub/v1beta2'; +export {recommender_v1beta1} from './apis/recommender/v1beta1'; export {redis_v1} from './apis/redis/v1'; export {redis_v1beta1} from './apis/redis/v1beta1'; export {remotebuildexecution_v1} from './apis/remotebuildexecution/v1'; @@ -225,6 +228,7 @@ export {replicapool_v1beta1} from './apis/replicapool/v1beta1'; export {reseller_v1} from './apis/reseller/v1'; export {run_v1} from './apis/run/v1'; export {run_v1alpha1} from './apis/run/v1alpha1'; +export {run_v1beta1} from './apis/run/v1beta1'; export {runtimeconfig_v1} from './apis/runtimeconfig/v1'; export {runtimeconfig_v1beta1} from './apis/runtimeconfig/v1beta1'; export {safebrowsing_v4} from './apis/safebrowsing/v4'; @@ -252,7 +256,8 @@ export {sourcerepo_v1} from './apis/sourcerepo/v1'; export {spanner_v1} from './apis/spanner/v1'; export {speech_v1} from './apis/speech/v1'; export {speech_v1p1beta1} from './apis/speech/v1p1beta1'; -export {speech_v2beta} from './apis/speech/v2beta'; +export {speech_v2beta1} from './apis/speech/v2beta1'; +export {sql_v1beta4} from './apis/sql/v1beta4'; export {sqladmin_v1beta4} from './apis/sqladmin/v1beta4'; export {storage_v1} from './apis/storage/v1'; export {storage_v1beta1} from './apis/storage/v1beta1'; @@ -271,7 +276,6 @@ export {tpu_v1} from './apis/tpu/v1'; export {tpu_v1alpha1} from './apis/tpu/v1alpha1'; export {translate_v2} from './apis/translate/v2'; export {translate_v3beta1} from './apis/translate/v3beta1'; -export {urlshortener_v1} from './apis/urlshortener/v1'; export {vault_v1} from './apis/vault/v1'; export {verifiedaccess_v1} from './apis/verifiedaccess/v1'; export {videointelligence_v1} from './apis/videointelligence/v1';