diff --git a/src/apis/abusiveexperiencereport/v1.ts b/src/apis/abusiveexperiencereport/v1.ts index e9ab9e226cf..36d1b94cbcb 100644 --- a/src/apis/abusiveexperiencereport/v1.ts +++ b/src/apis/abusiveexperiencereport/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Abusive Experience Report API + * Abusive Experience Report API * * View Abusive Experience Report data, and get a list of sites that have a * significant number of abusive experiences. @@ -67,7 +67,8 @@ export class Abusiveexperiencereport { } /** - * Response message for GetSiteSummary. + * Response message for GetSiteSummary. Do not confuse with same message in + * google.ads.experiencereport.v1 */ export interface Schema$SiteSummaryResponse { /** diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 774ade7e314..0899992bb52 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -329,7 +329,7 @@ export interface Schema$Correction { type: string; } /** - * A creative and its classification data. Next ID: 31 + * A creative and its classification data. Next ID: 35 */ export interface Schema$Creative { /** @@ -644,6 +644,12 @@ export interface Schema$FilterSet { * results must match any one of the platforms). */ platforms: string[]; + /** + * For Exchange Bidding buyers only. The list of publisher identifiers on + * which to filter; may be empty. The filters represented by multiple + * publisher identifiers are ORed together. + */ + publisherIdentifiers: string[]; /** * An open-ended realtime time range, defined by the aggregation start * timestamp. @@ -655,10 +661,10 @@ export interface Schema$FilterSet { */ relativeDateRange: Schema$RelativeDateRange; /** - * The list of IDs of the seller (publisher) networks on which to filter; may - * be empty. The filters represented by multiple seller network IDs are ORed - * together (i.e. if non-empty, results must match any one of the publisher - * networks). See + * For Ad Exchange buyers only. The list of IDs of the seller (publisher) + * networks on which to filter; may be empty. The filters represented by + * multiple seller network IDs are ORed together (i.e. if non-empty, results + * must match any one of the publisher networks). See * [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids) * file for the set of existing seller network IDs. */ @@ -993,6 +999,16 @@ export interface Schema$ListNonBillableWinningBidsResponse { */ nonBillableWinningBidStatusRows: Schema$NonBillableWinningBidStatusRow[]; } +/** + * Response message for listing publishers that had recent inventory matches + * with the requesting buyer. + */ +export interface Schema$ListPublishersResponse { + /** + * List of publishers. + */ + publisher: Schema$Publisher[]; +} /** * @OutputOnly The Geo criteria the restriction applies to. */ @@ -1107,6 +1123,26 @@ export interface Schema$PlatformContext { */ platforms: string[]; } +/** + * The publisher ID and name contain values relevant to the requesting buyer + * depending on whether it is an Ad Exchange buyer or Exchange Bidding buyer. + */ +export interface Schema$Publisher { + /** + * Publisher name contains: - Seller network name when the requesting buyer is + * an Ad Exchange buyer. - DFP network name or AdMob publisher code when the + * requesting buyer is an Exchange Bidding buyer. + */ + publisherDisplayName: string; + /** + * Publisher ID contains: - Seller network ID when the requesting buyer is an + * Ad Exchange buyer. See + * [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids) + * - DFP network code or AdMob publisher code when the requesting buyer is an + * Exchange Bidding buyer. + */ + publisherId: string; +} /** * An open-ended realtime time range specified by the start timestamp. For * filter sets that specify a realtime time range RTB metrics continue to be @@ -1283,11 +1319,13 @@ export class Resource$Accounts { root: Adexchangebuyer2; clients: Resource$Accounts$Clients; creatives: Resource$Accounts$Creatives; + publishers: Resource$Accounts$Publishers; constructor(root: Adexchangebuyer2) { this.root = root; this.getRoot.bind(this); this.clients = new Resource$Accounts$Clients(root); this.creatives = new Resource$Accounts$Creatives(root); + this.publishers = new Resource$Accounts$Publishers(root); } getRoot() { @@ -2459,6 +2497,77 @@ export class Resource$Accounts$Creatives$Dealassociations { } +export class Resource$Accounts$Publishers { + root: Adexchangebuyer2; + constructor(root: Adexchangebuyer2) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * adexchangebuyer2.accounts.publishers.list + * @desc Lists publishers that had recent inventory matches with the + * requesting buyer. + * @alias adexchangebuyer2.accounts.publishers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.accountId Account ID of the requesting buyer. + * @param {string=} params.environment Optional environment (WEB, APP) for which to return publishers. If specified, response will only include publishers that had recent inventory matches with the requesting buyer on the specified platform. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: any, options?: MethodOptions): + AxiosPromise; + list( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): void; + list( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://adexchangebuyer.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/accounts/{accountId}/publishers') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['accountId'], + pathParams: ['accountId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } +} + export class Resource$Bidders { root: Adexchangebuyer2; diff --git a/src/apis/adexperiencereport/v1.ts b/src/apis/adexperiencereport/v1.ts index c4af7a38097..6d048b839a2 100644 --- a/src/apis/adexperiencereport/v1.ts +++ b/src/apis/adexperiencereport/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Ad Experience Report API + * Ad Experience Report API * * View Ad Experience Report data, and get a list of sites that have a * significant number of annoying ads. @@ -100,7 +100,8 @@ export interface Schema$PlatformSummary { underReview: boolean; } /** - * Response message for GetSiteSummary. + * Response message for GetSiteSummary. Do not confuse with same message in + * google.chrome.abusiveexperiencereport.v1 */ export interface Schema$SiteSummaryResponse { /** diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index baff6a2ce79..7cfe3ce7fe0 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -449,7 +449,8 @@ export interface Schema$DevicesLongRunningOperationResponse { successCount: number; } /** - * An EMM's DPC ([device policy controller](/android/work/dpc/build-dpc)). + * An EMM's DPC ([device policy + * controller](http://developer.android.com/work/dpc/build-dpc.html)). * Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a * device to maintain the customer's mobile policies. All the DPCs listed by * the API support zero-touch enrollment and are available in Google Play. diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 728a860a4e7..44f95b632a7 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -1067,7 +1067,7 @@ export interface Schema$Policy { autoUpdatePolicy: string; /** * The maintenance window defining when apps running in the foreground should - * be updated. This feature is only supported on fully managed devices. + * be updated. */ maintenanceWindow: Schema$MaintenanceWindow; /** diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 2ba95f969d0..e8b50c18c27 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -139,7 +139,8 @@ export interface Schema$ApplicationPolicy { /** * The default policy for all permissions requested by the app. If specified, * this overrides the policy-level default_permission_policy which applies to - * all apps. + * all apps. It does not override the permission_grants which applies to all + * apps. */ defaultPermissionPolicy: string; /** @@ -190,7 +191,8 @@ export interface Schema$ApplicationPolicy { packageName: string; /** * Explicit permission grants or denials for the app. These values override - * the default_permission_policy. + * the default_permission_policy and permission_grants which apply to all + * apps. */ permissionGrants: Schema$PermissionGrant[]; } @@ -571,6 +573,11 @@ export interface Schema$Enterprise { * notifications are enabled. */ pubsubTopic: string; + /** + * Terms and conditions that must be accepted when provisioning a device for + * this enterprise. A page of terms is generated for each value in this list. + */ + termsAndConditions: Schema$TermsAndConditions[]; } /** * Data hosted at an external location. The data is to be downloaded by Android @@ -1364,7 +1371,7 @@ export interface Schema$Policy { usbFileTransferDisabled: boolean; /** * Allows admins to toggle whether USB storge is enabled or disabled on - * user's devices. Next ID: 114 + * user's devices. */ usbMassStorageEnabled: boolean; /** @@ -1594,6 +1601,20 @@ export interface Schema$SystemUpdate { */ type: string; } +/** + * A terms and conditions page to be accepted during provisioning. + */ +export interface Schema$TermsAndConditions { + /** + * A well-formatted HTML string. It will be parsed on the client with + * android.text.Html#fromHtml. + */ + content: Schema$UserFacingMessage; + /** + * A short header which appears above the HTML content. + */ + header: Schema$UserFacingMessage; +} /** * Provides a user-facing message with locale info. The maximum message length * is 4096 characters. diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index b0e0b15b57c..e7ed1e7f4f5 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -180,6 +180,14 @@ export interface Schema$BigtableOptions { */ readRowkeyAsString: boolean; } +export interface Schema$Clustering { + /** + * [Repeated] One or more fields on which data should be clustered. Only + * top-level, non-repeated, simple-type fields are supported. The order of the + * fields will determine how clusters will be generated, so it is important. + */ + fields: string[]; +} export interface Schema$CsvOptions { /** * [Optional] Indicates if BigQuery should accept rows that are missing @@ -661,6 +669,11 @@ export interface Schema$GetServiceAccountResponse { kind: string; } export interface Schema$GoogleSheetsOptions { + /** + * [Experimental] [Optional] Range of a sheet to query from. Only used when + * non-empty. Typical format: !: + */ + range: string; /** * [Optional] The number of rows at the top of a sheet that BigQuery will skip * when reading the data. The default value is 0. This property is useful if @@ -819,10 +832,16 @@ export interface Schema$JobConfigurationLoad { */ allowQuotedNewlines: boolean; /** - * Indicates if we should automatically infer the options and schema for CSV - * and JSON sources. + * [Optional] Indicates if we should automatically infer the options and + * schema for CSV and JSON sources. */ autodetect: boolean; + /** + * [Experimental] Clustering specification for the destination table. Must be + * specified with time-based partitioning, data in the table will be first + * partitioned and subsequently clustered. + */ + clustering: Schema$Clustering; /** * [Optional] Specifies whether the job is allowed to create new tables. The * following values are supported: CREATE_IF_NEEDED: If the table does not @@ -964,7 +983,7 @@ export interface Schema$JobConfigurationLoad { */ sourceUris: string[]; /** - * If specified, configures time-based partitioning for the destination table. + * Time-based partitioning specification for the destination table. */ timePartitioning: Schema$TimePartitioning; /** @@ -990,6 +1009,12 @@ export interface Schema$JobConfigurationQuery { * size. */ allowLargeResults: boolean; + /** + * [Experimental] Clustering specification for the destination table. Must be + * specified with time-based partitioning, data in the table will be first + * partitioned and subsequently clustered. + */ + clustering: Schema$Clustering; /** * [Optional] Specifies whether the job is allowed to create new tables. The * following values are supported: CREATE_IF_NEEDED: If the table does not @@ -1077,7 +1102,7 @@ export interface Schema$JobConfigurationQuery { */ tableDefinitions: any; /** - * If specified, configures time-based partitioning for the destination table. + * Time-based partitioning specification for the destination table. */ timePartitioning: Schema$TimePartitioning; /** @@ -1634,6 +1659,12 @@ export interface Schema$Streamingbuffer { oldestEntryTime: string; } export interface Schema$Table { + /** + * [Experimental] Clustering specification for the table. Must be specified + * with time-based partitioning, data in the table will be first partitioned + * and subsequently clustered. + */ + clustering: Schema$Clustering; /** * [Output-only] The time when this table was created, in milliseconds since * the epoch. @@ -1730,7 +1761,7 @@ export interface Schema$Table { */ tableReference: Schema$TableReference; /** - * If specified, configures time-based partitioning for this table. + * Time-based partitioning specification for this table. */ timePartitioning: Schema$TimePartitioning; /** diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index 567ddc154be..cf205b98c01 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -1137,7 +1137,7 @@ export class Resource$Projects$Locations$Transferconfigs { * * @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 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 {().TransferConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1745,7 +1745,7 @@ export class Resource$Projects$Transferconfigs { * * @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 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 {().TransferConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index eaa15df6cc1..a51be989885 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -256,7 +256,7 @@ export interface Schema$Course { id: string; /** * Name of the course. For example, "10th Grade Biology". The name - * is required. It must be between 1 and 750 characters and a valid UTF-8 + * is required. It must be between 1 and 50 characters and a valid UTF-8 * string. */ name: string; @@ -862,20 +862,6 @@ export interface Schema$ListTeachersResponse { */ teachers: Schema$Teacher[]; } -/** - * Response when listing topics. - */ -export interface Schema$ListTopicResponse { - /** - * Token identifying the next page of results to return. If empty, no further - * results are available. - */ - nextPageToken: string; - /** - * Topic items that match the request. - */ - topic: Schema$Topic[]; -} /** * Material attached to course work. When creating attachments, setting the * `form` field is not supported. @@ -1236,30 +1222,6 @@ export interface Schema$TimeOfDay { */ seconds: number; } -/** - * Topic created by a teacher for the course - */ -export interface Schema$Topic { - /** - * Identifier of the course. Read-only. - */ - courseId: string; - /** - * The name of the topic, generated by the user. Leading and trailing - * whitespaces, if any, will be trimmed. Also, multiple consecutive - * whitespaces will be collapsed into one inside the name. Topic names are - * case sensitive, and must be no longer than 100 characters. - */ - name: string; - /** - * Unique identifier for the topic. Read-only. - */ - topicId: string; - /** - * The time the topic was last updated by the system. Read-only. - */ - updateTime: string; -} /** * Request to turn in a student submission. */ @@ -1325,7 +1287,6 @@ export class Resource$Courses { courseWork: Resource$Courses$Coursework; students: Resource$Courses$Students; teachers: Resource$Courses$Teachers; - topics: Resource$Courses$Topics; constructor(root: Classroom) { this.root = root; this.getRoot.bind(this); @@ -1334,7 +1295,6 @@ export class Resource$Courses { this.courseWork = new Resource$Courses$Coursework(root); this.students = new Resource$Courses$Students(root); this.teachers = new Resource$Courses$Teachers(root); - this.topics = new Resource$Courses$Topics(root); } getRoot() { @@ -3623,132 +3583,6 @@ export class Resource$Courses$Teachers { } } -export class Resource$Courses$Topics { - root: Classroom; - constructor(root: Classroom) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * classroom.courses.topics.get - * @desc Returns a topic. This method returns the following error codes: * - * `PERMISSION_DENIED` if the requesting user is not permitted to access the - * requested course or topic, or for access errors. * `INVALID_ARGUMENT` if - * the request is malformed. * `NOT_FOUND` if the requested course or topic - * does not exist. - * @alias classroom.courses.topics.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.courseId Identifier of the course. - * @param {string} params.id Identifier of the topic. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get(params?: any, options?: MethodOptions): AxiosPromise; - get(params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - get(params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - if (typeof options === 'function') { - callback = options; - options = {}; - } - if (typeof params === 'function') { - callback = params; - params = {}; - } - options = options || {}; - const rootUrl = options.rootUrl || 'https://classroom.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/courses/{courseId}/topics/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['courseId', 'id'], - pathParams: ['courseId', 'id'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * classroom.courses.topics.list - * @desc Returns the list of topics that the requester is permitted to view. - * This method returns the following error codes: * `PERMISSION_DENIED` if - * the requesting user is not permitted to access the requested course or for - * access errors. * `INVALID_ARGUMENT` if the request is malformed. * - * `NOT_FOUND` if the requested course does not exist. - * @alias classroom.courses.topics.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. - * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. - * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this 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?: any, options?: MethodOptions): - AxiosPromise; - list( - params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - list( - params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - if (typeof options === 'function') { - callback = options; - options = {}; - } - if (typeof params === 'function') { - callback = params; - params = {}; - } - options = options || {}; - const rootUrl = options.rootUrl || 'https://classroom.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/courses/{courseId}/topics') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['courseId'], - pathParams: ['courseId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } -} - export class Resource$Invitations { root: Classroom; diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index 7f849a05ba3..a2295b8978c 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -106,7 +106,7 @@ export interface Schema$AggregationInfo { */ export interface Schema$AuditConfig { /** - * The configuration for logging of each type of permission. Next ID: 4 + * The configuration for logging of each type of permission. */ auditLogConfigs: Schema$AuditLogConfig[]; /** @@ -597,10 +597,10 @@ export class Resource$Billingaccounts { /** * cloudbilling.billingAccounts.create * @desc Creates a billing account. This method can only be used to create - * [billing subaccounts](https://cloud.google.com/billing/docs/concepts). When - * creating a subaccount, the current authenticated user must have the - * `billing.accounts.update` IAM permission on the master account, which is - * typically given to billing account + * [billing subaccounts](https://cloud.google.com/billing/docs/concepts) for + * GCP resellers. When creating a subaccount, the current authenticated user + * must have the `billing.accounts.update` IAM permission on the master + * account, which is typically given to billing account * [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). * > This method is currently in > * [Beta](https://cloud.google.com/terms/launch-stages). diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index d660e9060d8..4072a271776 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -31,8 +31,7 @@ import {createAPIRequest} from '../../lib/apirequest'; /** * Google Cloud Functions API * - * API for managing lightweight user-provided functions executed in response to - * events. + * Manages lightweight user-provided functions executed in response to events. * * @example * const google = require('googleapis'); @@ -312,6 +311,11 @@ export interface Schema$ListOperationsResponse { * A resource that represents Google Cloud Platform location. */ export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For + * example, "Tokyo". + */ + displayName: string; /** * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} @@ -975,7 +979,7 @@ export class Resource$Projects$Locations$Functions { * URL, please follow these restrictions: * Source file type should be a zip * file. * Source file size should not exceed 100MB limit. When making a HTTP * PUT request, these two headers need to be specified: * `content-type: - * application/zip` * `x-google-content-length-range: 0,104857600` + * application/zip` * `x-goog-content-length-range: 0,104857600` * @alias cloudfunctions.projects.locations.functions.generateUploadUrl * @memberOf! () * diff --git a/src/apis/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index 268a9433e77..c5693e40fc9 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -31,8 +31,7 @@ import {createAPIRequest} from '../../lib/apirequest'; /** * Google Cloud Functions API * - * API for managing lightweight user-provided functions executed in response to - * events. + * Manages lightweight user-provided functions executed in response to events. * * @example * const google = require('googleapis'); @@ -318,6 +317,11 @@ export interface Schema$ListOperationsResponse { * A resource that represents Google Cloud Platform location. */ export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For + * example, "Tokyo". + */ + displayName: string; /** * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} @@ -998,7 +1002,7 @@ export class Resource$Projects$Locations$Functions { * URL, please follow these restrictions: * Source file type should be a zip * file. * Source file size should not exceed 100MB limit. When making a HTTP * PUT request, these two headers need to be specified: * `content-type: - * application/zip` * `x-google-content-length-range: 0,104857600` + * application/zip` * `x-goog-content-length-range: 0,104857600` * @alias cloudfunctions.projects.locations.functions.generateUploadUrl * @memberOf! () * diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index 99292fb8ba2..0807bcae983 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -442,18 +442,22 @@ export interface Schema$MqttConfig { /** * 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index d5ad196c9aa..57e748f9501 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Key Management Service (KMS) API + * Cloud Key Management Service (KMS) API * * Manages encryption for your cloud services the same way you do on-premises. * You can generate, use, rotate, and destroy AES256 encryption keys. @@ -396,18 +396,22 @@ export interface Schema$Location { /** * 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 2cdb0e4bd46..5900c1052cf 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -147,14 +147,13 @@ export interface Schema$Binding { * 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` or - * `joe@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}`: A Google Apps domain name that - * represents all the users of that domain. For example, `google.com` or - * `example.com`. + * specific Google account. For example, `alice@gmail.com` . * + * `serviceAccount:{emailid}`: An email address that represents a service + * account. For example, `my-other-app@appspot.gserviceaccount.com`. * + * `group:{emailid}`: An email address that represents a Google group. For + * example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain + * name that represents all the users of that domain. For example, + * `google.com` or `example.com`. */ members: string[]; /** @@ -315,7 +314,7 @@ export interface Schema$GetAncestryResponse { /** * Ancestors are ordered from bottom to top of the resource hierarchy. The * first ancestor is the project itself, followed by the project's parent, - * etc. + * etc.. */ ancestor: Schema$Ancestor[]; } @@ -721,18 +720,22 @@ export interface Schema$OrgPolicy { /** * 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** @@ -4806,22 +4809,24 @@ export class Resource$Projects { * console and must accept the invitation. + A user cannot be granted the * owner role using `setIamPolicy()`. The user must be granted the owner role * using the Cloud Platform Console and must explicitly accept the invitation. - * + Invitations to grant the owner role cannot be sent using - * `setIamPolicy()`; they must be sent only using the Cloud Platform Console. - * + Membership changes that leave the project without any owners that have - * accepted the Terms of Service (ToS) will be rejected. + If the project is - * not part of an organization, there must be at least one owner who has - * accepted the Terms of Service (ToS) agreement in the policy. Calling - * `setIamPolicy()` to remove the last ToS-accepted owner from the policy will - * fail. This restriction also applies to legacy projects that no longer have - * owners who have accepted the ToS. Edits to IAM policies will be rejected - * until the lack of a ToS-accepting owner is rectified. + This method will - * replace the existing policy, and cannot be used to append additional IAM - * settings. Note: Removing service accounts from policies or changing their - * roles can render services completely inoperable. It is important to - * understand how the service account is being used before removing or - * updating its roles. Authorization requires the Google IAM permission - * `resourcemanager.projects.setIamPolicy` on the project + * + You can only grant ownership of a project to a member by using the GCP + * Console. Inviting a member will deliver an invitation email that they must + * accept. An invitation email is not generated if you are granting a role + * other than owner, or if both the member you are inviting and the project + * are part of your organization. + Membership changes that leave the project + * without any owners that have accepted the Terms of Service (ToS) will be + * rejected. + If the project is not part of an organization, there must be + * at least one owner who has accepted the Terms of Service (ToS) agreement in + * the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner + * from the policy will fail. This restriction also applies to legacy projects + * that no longer have owners who have accepted the ToS. Edits to IAM policies + * will be rejected until the lack of a ToS-accepting owner is rectified. + + * This method will replace the existing policy, and cannot be used to append + * additional IAM settings. Note: Removing service accounts from policies or + * changing their roles can render services completely inoperable. It is + * important to understand how the service account is being used before + * removing or updating its roles. Authorization requires the Google IAM + * permission `resourcemanager.projects.setIamPolicy` on the project * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 99509ebe6e9..f7573d5ce2c 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -141,14 +141,13 @@ export interface Schema$Binding { * 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` or - * `joe@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}`: A Google Apps domain name that - * represents all the users of that domain. For example, `google.com` or - * `example.com`. + * specific Google account. For example, `alice@gmail.com` . * + * `serviceAccount:{emailid}`: An email address that represents a service + * account. For example, `my-other-app@appspot.gserviceaccount.com`. * + * `group:{emailid}`: An email address that represents a Google group. For + * example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain + * name that represents all the users of that domain. For example, + * `google.com` or `example.com`. */ members: string[]; /** @@ -311,18 +310,22 @@ export interface Schema$OrganizationOwner { /** * 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 6ad5ed09194..0c44ba132da 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -130,14 +130,13 @@ export interface Schema$Binding { * 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` or - * `joe@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}`: A Google Apps domain name that - * represents all the users of that domain. For example, `google.com` or - * `example.com`. + * specific Google account. For example, `alice@gmail.com` . * + * `serviceAccount:{emailid}`: An email address that represents a service + * account. For example, `my-other-app@appspot.gserviceaccount.com`. * + * `group:{emailid}`: An email address that represents a Google group. For + * example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain + * name that represents all the users of that domain. For example, + * `google.com` or `example.com`. */ members: string[]; /** @@ -284,18 +283,22 @@ export interface Schema$Operation { /** * 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 64ceffcdd70..6e0a6819b82 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -130,14 +130,13 @@ export interface Schema$Binding { * 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` or - * `joe@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}`: A Google Apps domain name that - * represents all the users of that domain. For example, `google.com` or - * `example.com`. + * specific Google account. For example, `alice@gmail.com` . * + * `serviceAccount:{emailid}`: An email address that represents a service + * account. For example, `my-other-app@appspot.gserviceaccount.com`. * + * `group:{emailid}`: An email address that represents a Google group. For + * example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain + * name that represents all the users of that domain. For example, + * `google.com` or `example.com`. */ members: string[]; /** @@ -284,18 +283,22 @@ export interface Schema$Operation { /** * 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 1c014b9f187..e96f0bb790d 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -515,18 +515,22 @@ 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** @@ -1013,7 +1017,7 @@ export class Resource$Projects$Locations { /** * cloudtasks.projects.locations.get - * @desc Get information about a location. + * @desc Gets information about a location. * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 89462c72fcd..7551e6ce981 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -76,11 +76,11 @@ export class Compute { licenseCodes: Resource$Licensecodes; licenses: Resource$Licenses; machineTypes: Resource$Machinetypes; - maintenancePolicies: Resource$Maintenancepolicies; networkEndpointGroups: Resource$Networkendpointgroups; networks: Resource$Networks; nodeGroups: Resource$Nodegroups; nodeTemplates: Resource$Nodetemplates; + nodeTypes: Resource$Nodetypes; projects: Resource$Projects; regionAutoscalers: Resource$Regionautoscalers; regionBackendServices: Resource$Regionbackendservices; @@ -146,11 +146,11 @@ export class Compute { this.licenseCodes = new Resource$Licensecodes(this); this.licenses = new Resource$Licenses(this); this.machineTypes = new Resource$Machinetypes(this); - this.maintenancePolicies = new Resource$Maintenancepolicies(this); this.networkEndpointGroups = new Resource$Networkendpointgroups(this); this.networks = new Resource$Networks(this); this.nodeGroups = new Resource$Nodegroups(this); this.nodeTemplates = new Resource$Nodetemplates(this); + this.nodeTypes = new Resource$Nodetypes(this); this.projects = new Resource$Projects(this); this.regionAutoscalers = new Resource$Regionautoscalers(this); this.regionBackendServices = new Resource$Regionbackendservices(this); @@ -320,7 +320,7 @@ export interface Schema$AcceleratorTypeList { } export interface Schema$AcceleratorTypesScopedList { /** - * [Output Only] List of accelerator types contained in this scope. + * [Output Only] A list of accelerator types contained in this scope. */ acceleratorTypes: Schema$AcceleratorType[]; /** @@ -532,7 +532,7 @@ export interface Schema$AddressAggregatedList { } export interface Schema$AddressesScopedList { /** - * [Output Only] List of addresses contained in this scope. + * [Output Only] A list of addresses contained in this scope. */ addresses: Schema$Address[]; /** @@ -981,7 +981,7 @@ export interface Schema$AutoscalerList { } export interface Schema$AutoscalersScopedList { /** - * [Output Only] List of autoscalers contained in this scope. + * [Output Only] A list of autoscalers contained in this scope. */ autoscalers: Schema$Autoscaler[]; /** @@ -1699,7 +1699,7 @@ export interface Schema$BackendServiceList { export interface Schema$BackendServiceReference { backendService: string; } export interface Schema$BackendServicesScopedList { /** - * List of BackendServices contained in this scope. + * A list of BackendServices contained in this scope. */ backendServices: Schema$BackendService[]; /** @@ -1840,7 +1840,7 @@ export interface Schema$Commitment { */ region: string; /** - * List of commitment amounts for particular resources. Note that VCPU and + * A list of commitment amounts for particular resources. Note that VCPU and * MEMORY resource commitments must occur together. */ resources: Schema$ResourceCommitment[]; @@ -1937,7 +1937,7 @@ export interface Schema$CommitmentList { } export interface Schema$CommitmentsScopedList { /** - * [Output Only] List of commitments contained in this scope. + * [Output Only] A list of commitments contained in this scope. */ commitments: Schema$Commitment[]; /** @@ -2006,7 +2006,7 @@ export interface Schema$CustomerEncryptionKey { * resource. The key must meet the following requirements before you can * provide it to Compute Engine: - The key is wrapped using a RSA public key * certificate provided by Google. - After being wrapped, the key must be - * encoded in RFC 4648 base64 encoding. Get the RSA public key certificate + * encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate * provided by Google at: * https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem */ @@ -2029,25 +2029,6 @@ export interface Schema$CustomerEncryptionKeyProtectedDisk { */ source: string; } -/** - * Time window specified for daily maintenance operations. - */ -export interface Schema$DailyMaintenanceWindow { - /** - * Allows to define schedule that runs every nth day of the month. - */ - daysInCycle: number; - /** - * [Output only] Duration of the time window, automatically chosen to be - * smallest possible in the given scenario. - */ - duration: string; - /** - * Time within the maintenance window to start the maintenance operations. It - * must be in format "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. - */ - startTime: string; -} /** * Deprecation status for a public resource. */ @@ -2398,7 +2379,7 @@ export interface Schema$DisksResizeRequest { } export interface Schema$DisksScopedList { /** - * [Output Only] List of disks contained in this scope. + * [Output Only] A list of disks contained in this scope. */ disks: Schema$Disk[]; /** @@ -2522,7 +2503,7 @@ export interface Schema$DiskTypeList { } export interface Schema$DiskTypesScopedList { /** - * [Output Only] List of disk types contained in this scope. + * [Output Only] A list of disk types contained in this scope. */ diskTypes: Schema$DiskType[]; /** @@ -3034,7 +3015,7 @@ export interface Schema$ForwardingRuleList { export interface Schema$ForwardingRuleReference { forwardingRule: string; } export interface Schema$ForwardingRulesScopedList { /** - * List of forwarding rules contained in this scope. + * A list of forwarding rules contained in this scope. */ forwardingRules: Schema$ForwardingRule[]; /** @@ -3246,7 +3227,7 @@ export interface Schema$HealthChecksAggregatedList { } export interface Schema$HealthChecksScopedList { /** - * List of HealthChecks contained in this scope. + * A list of HealthChecks contained in this scope. */ healthChecks: Schema$HealthCheck[]; /** @@ -3455,7 +3436,7 @@ export interface Schema$HostRule { } export interface Schema$HostsScopedList { /** - * [Output Only] List of hosts contained in this scope. + * [Output Only] A list of hosts contained in this scope. */ hosts: Schema$Host[]; /** @@ -3589,7 +3570,7 @@ export interface Schema$HostTypeList { } export interface Schema$HostTypesScopedList { /** - * [Output Only] List of host types contained in this scope. + * [Output Only] A list of host types contained in this scope. */ hostTypes: Schema$HostType[]; /** @@ -3598,25 +3579,6 @@ export interface Schema$HostTypesScopedList { */ warning: any; } -/** - * Time window specified for hourly maintenance operations. - */ -export interface Schema$HourlyMaintenanceWindow { - /** - * [Output only] Duration of the time window, automatically chosen to be - * smallest possible in the given scenario. - */ - duration: string; - /** - * Allows to define schedule that runs every nth hour. - */ - hoursInCycle: number; - /** - * Time within the maintenance window to start the maintenance operations. It - * must be in format "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. - */ - startTime: string; -} export interface Schema$HTTP2HealthCheck { /** * The value of the host header in the HTTP/2 health check request. If left @@ -4201,7 +4163,7 @@ export interface Schema$Instance { */ disks: Schema$AttachedDisk[]; /** - * List of the type and count of accelerator cards attached to the instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators: Schema$AcceleratorConfig[]; /** @@ -4265,10 +4227,6 @@ export interface Schema$Instance { * restrictions, read the Specifications for custom machine types. */ machineType: string; - /** - * Maintenance policies applied to this instance. - */ - maintenancePolicies: string[]; /** * The metadata key/value pairs assigned to this instance. This includes * custom metadata and predefined keys. @@ -4429,8 +4387,8 @@ export interface Schema$InstanceGroup { */ network: string; /** - * The URL of the region where the instance group is located (for regional - * resources). + * [Output Only] The URL of the region where the instance group is located + * (for regional resources). */ region: string; /** @@ -4443,8 +4401,8 @@ export interface Schema$InstanceGroup { */ size: number; /** - * The URL of the subnetwork to which all instances in the instance group - * belong. + * [Output Only] The URL of the subnetwork to which all instances in the + * instance group belong. */ subnetwork: string; /** @@ -5312,18 +5270,6 @@ export interface Schema$InstanceReference { */ instance: string; } -export interface Schema$InstancesAddMaintenancePoliciesRequest { - /** - * Maintenance policies to be added to this instance. - */ - maintenancePolicies: string[]; -} -export interface Schema$InstancesRemoveMaintenancePoliciesRequest { - /** - * Maintenance policies to be removed from this instance. - */ - maintenancePolicies: string[]; -} export interface Schema$InstancesResumeRequest { /** * Array of disks associated with this instance that are protected with a @@ -5343,7 +5289,7 @@ export interface Schema$InstancesResumeRequest { } export interface Schema$InstancesScopedList { /** - * [Output Only] List of instances contained in this scope. + * [Output Only] A list of instances contained in this scope. */ instances: Schema$Instance[]; /** @@ -5363,7 +5309,7 @@ export interface Schema$InstancesSetLabelsRequest { } export interface Schema$InstancesSetMachineResourcesRequest { /** - * List of the type and count of accelerator cards attached to the instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators: Schema$AcceleratorConfig[]; } @@ -5528,7 +5474,7 @@ export interface Schema$Interconnect { */ adminEnabled: boolean; /** - * [Output Only] List of CircuitInfo objects, that describe the individual + * [Output Only] A list of CircuitInfo objects, that describe the individual * circuits in this LAG. */ circuitInfos: Schema$InterconnectCircuitInfo[]; @@ -5547,7 +5493,7 @@ export interface Schema$Interconnect { */ description: string; /** - * [Output Only] List of outages expected for this Interconnect. + * [Output Only] A list of outages expected for this Interconnect. */ expectedOutages: Schema$InterconnectOutageNotification[]; /** @@ -5923,7 +5869,7 @@ export interface Schema$InterconnectAttachmentPrivateInfo { } export interface Schema$InterconnectAttachmentsScopedList { /** - * List of interconnect attachments contained in this scope. + * A list of interconnect attachments contained in this scope. */ interconnectAttachments: Schema$InterconnectAttachment[]; /** @@ -6538,7 +6484,7 @@ export interface Schema$MachineTypeList { } export interface Schema$MachineTypesScopedList { /** - * [Output Only] List of machine types contained in this scope. + * [Output Only] A list of machine types contained in this scope. */ machineTypes: Schema$MachineType[]; /** @@ -6547,130 +6493,6 @@ export interface Schema$MachineTypesScopedList { */ warning: any; } -export interface Schema$MaintenancePoliciesList { - /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. - */ - id: string; - /** - * [Output Only] A list of MaintenancePolicy resources. - */ - items: Schema$MaintenancePolicy[]; - /** - * [Output Only] Type of resource.Always compute#maintenancePoliciesList for - * listsof maintenancePolicies - */ - kind: string; - /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use the - * nextPageToken as a value for the query parameter pageToken in the next list - * request. Subsequent list requests will have their own nextPageToken to - * continue paging through the results. - */ - nextPageToken: string; - /** - * [Output Only] Server-defined URL for this resource. - */ - selfLink: string; - /** - * [Output Only] Informational warning message. - */ - warning: any; -} -export interface Schema$MaintenancePoliciesScopedList { - /** - * List of maintenancePolicies contained in this scope. - */ - maintenancePolicies: Schema$MaintenancePolicy[]; - /** - * Informational warning which replaces the list of maintenancePolicies when - * the list is empty. - */ - warning: any; -} -/** - * A maintenance policy for an instance. This specifies what kind of maintenance - * operations our infrastructure may perform on this instance and when. - */ -export interface Schema$MaintenancePolicy { - /** - * [Output Only] Creation timestamp in RFC3339 text format. - */ - creationTimestamp: string; - description: string; - /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. - */ - id: string; - /** - * [Output Only] Type of the resource. Always compute#maintenance_policies for - * maintenance policies. - */ - kind: string; - /** - * The name of the resource, provided by the client when initially creating - * the resource. The resource name must be 1-63 characters long, and comply - * with RFC1035. Specifically, the name must be 1-63 characters long and match - * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must be - * a dash, lowercase letter, or digit, except the last character, which cannot - * be a dash. - */ - name: string; - region: string; - /** - * [Output Only] Server-defined fully-qualified URL for this resource. - */ - selfLink: string; - /** - * Maintenance policy applicable to VMs for infrastructure maintenance. - */ - vmMaintenancePolicy: Schema$VmMaintenancePolicy; -} -/** - * Contains a list of maintenancePolicies. - */ -export interface Schema$MaintenancePolicyAggregatedList { - /** - * [Output Only] Unique identifier for the resource; defined by the server. - */ - id: string; - /** - * A list of MaintenancePolicy resources. - */ - items: any; - /** - * Type of resource. - */ - kind: string; - /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use the - * nextPageToken as a value for the query parameter pageToken in the next list - * request. Subsequent list requests will have their own nextPageToken to - * continue paging through the results. - */ - nextPageToken: string; - /** - * [Output Only] Server-defined URL for this resource. - */ - selfLink: string; - /** - * [Output Only] Informational warning message. - */ - warning: any; -} -/** - * A maintenance window for VMs and disks. When set, we restrict our maintenance - * operations to this window. - */ -export interface Schema$MaintenanceWindow { - dailyMaintenanceWindow: Schema$DailyMaintenanceWindow; - hourlyMaintenanceWindow: Schema$HourlyMaintenanceWindow; -} /** * Next available tag: 12 */ @@ -6888,7 +6710,7 @@ export interface Schema$Network { */ name: string; /** - * [Output Only] List of network peerings for the resource. + * [Output Only] A list of network peerings for the resource. */ peerings: Schema$NetworkPeering[]; /** @@ -7322,6 +7144,445 @@ export interface Schema$NetworksRemovePeeringRequest { */ name: string; } +/** + * A NodeGroup resource. + */ +export interface Schema$NodeGroup { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp: string; + /** + * [Output Only] An optional textual description of the resource. + */ + description: string; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id: string; + /** + * [Output Only] The type of the resource. Always compute#nodeGroup for node + * group. + */ + kind: string; + /** + * The name of the resource, provided by the client when initially creating + * the resource. The resource name must be 1-63 characters long, and comply + * with RFC1035. Specifically, the name must be 1-63 characters long and match + * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + * character must be a lowercase letter, and all following characters must be + * a dash, lowercase letter, or digit, except the last character, which cannot + * be a dash. + */ + name: string; + /** + * [Output Only] A list of nodes in this node group. + */ + nodes: Schema$NodeGroupNode[]; + /** + * The URL of the node template to which this node group belongs. + */ + nodeTemplate: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink: string; + status: string; + /** + * [Output Only] The name of the zone where the node group resides, such as + * us-central1-a. + */ + zone: string; +} +export interface Schema$NodeGroupAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id: string; + /** + * A list of NodeGroupsScopedList resources. + */ + items: any; + /** + * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for + * aggregated lists of node groups. + */ + kind: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use the + * nextPageToken as a value for the query parameter pageToken in the next list + * request. Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink: string; + /** + * [Output Only] Informational warning message. + */ + warning: any; +} +/** + * Contains a list of nodeGroups. + */ +export interface Schema$NodeGroupList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id: string; + /** + * A list of NodeGroup resources. + */ + items: Schema$NodeGroup[]; + /** + * [Output Only] Type of resource.Always compute#nodeGroupList for lists of + * node groups. + */ + kind: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use the + * nextPageToken as a value for the query parameter pageToken in the next list + * request. Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink: string; + /** + * [Output Only] Informational warning message. + */ + warning: any; +} +export interface Schema$NodeGroupNode { + index: number; + /** + * Instances scheduled on this node. + */ + instances: string[]; + /** + * The type of this node. + */ + nodeType: string; +} +export interface Schema$NodeGroupsAddNodesRequest { + /** + * Count of additional nodes to be added to the node group. + */ + additionalNodeCount: number; +} +export interface Schema$NodeGroupsDeleteNodesRequest { + /** + * Indexes of the nodes to be deleted from the node group. + */ + nodeIndexes: number[]; +} +export interface Schema$NodeGroupsScopedList { + /** + * [Output Only] A list of node groups contained in this scope. + */ + nodeGroups: Schema$NodeGroup[]; + /** + * [Output Only] An informational warning that appears when the nodeGroup list + * is empty. + */ + warning: any; +} +export interface Schema$NodeGroupsSetNodeTemplateRequest { + /** + * Full or partial URL of the node template resource to be updated for this + * node group. + */ + nodeTemplate: string; +} +/** + * A Node Template resource. + */ +export interface Schema$NodeTemplate { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp: string; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description: string; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id: string; + /** + * [Output Only] The type of the resource. Always compute#nodeTemplate for + * node templates. + */ + kind: string; + /** + * The name of the resource, provided by the client when initially creating + * the resource. The resource name must be 1-63 characters long, and comply + * with RFC1035. Specifically, the name must be 1-63 characters long and match + * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + * character must be a lowercase letter, and all following characters must be + * a dash, lowercase letter, or digit, except the last charaicter, which + * cannot be a dash. + */ + name: string; + /** + * Labels to use for node affinity, which will be used in instance scheduling. + */ + nodeAffinityLabels: any; + /** + * The node type to use for nodes group that are created from this template. + */ + nodeType: string; + /** + * The flexible properties of the desired node type. Node groups that use this + * node template will create nodes of a type that matches these properties. + * This field is mutually exclusive with the node_type property; you can only + * define one or the other, but not both. + */ + nodeTypeFlexibility: Schema$NodeTemplateNodeTypeFlexibility; + /** + * [Output Only] The name of the region where the node template resides, such + * as us-central1. + */ + region: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink: string; + /** + * [Output Only] The status of the node template. One of the following values: + * CREATING, READY, and DELETING. + */ + status: string; + /** + * [Output Only] An optional, human-readable explanation of the status. + */ + statusMessage: string; +} +export interface Schema$NodeTemplateAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id: string; + /** + * A list of NodeTemplatesScopedList resources. + */ + items: any; + /** + * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList + * for aggregated lists of node templates. + */ + kind: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use the + * nextPageToken as a value for the query parameter pageToken in the next list + * request. Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink: string; + /** + * [Output Only] Informational warning message. + */ + warning: any; +} +/** + * Contains a list of node templates. + */ +export interface Schema$NodeTemplateList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id: string; + /** + * A list of NodeTemplate resources. + */ + items: Schema$NodeTemplate[]; + /** + * [Output Only] Type of resource.Always compute#nodeTemplateList for lists of + * node templates. + */ + kind: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use the + * nextPageToken as a value for the query parameter pageToken in the next list + * request. Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink: string; + /** + * [Output Only] Informational warning message. + */ + warning: any; +} +export interface Schema$NodeTemplateNodeTypeFlexibility { + cpus: string; + localSsd: string; + memory: string; +} +export interface Schema$NodeTemplatesScopedList { + /** + * [Output Only] A list of node templates contained in this scope. + */ + nodeTemplates: Schema$NodeTemplate[]; + /** + * [Output Only] An informational warning that appears when the node templates + * list is empty. + */ + warning: any; +} +/** + * A Node Type resource. + */ +export interface Schema$NodeType { + /** + * [Output Only] The CPU platform used by this node type. + */ + cpuPlatform: string; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp: string; + /** + * [Output Only] The deprecation status associated with this node type. + */ + deprecated: Schema$DeprecationStatus; + /** + * [Output Only] An optional textual description of the resource. + */ + description: string; + /** + * [Output Only] The number of virtual CPUs that are available to the node + * type. + */ + guestCpus: number; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id: string; + /** + * [Output Only] The type of the resource. Always compute#nodeType for node + * types. + */ + kind: string; + /** + * [Output Only] Local SSD available to the node type, defined in GB. + */ + localSsdGb: number; + /** + * [Output Only] The amount of physical memory available to the node type, + * defined in MB. + */ + memoryMb: number; + /** + * [Output Only] Name of the resource. + */ + name: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink: string; + /** + * [Output Only] The name of the zone where the node type resides, such as + * us-central1-a. + */ + zone: string; +} +export interface Schema$NodeTypeAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id: string; + /** + * A list of NodeTypesScopedList resources. + */ + items: any; + /** + * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for + * aggregated lists of node types. + */ + kind: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use the + * nextPageToken as a value for the query parameter pageToken in the next list + * request. Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink: string; + /** + * [Output Only] Informational warning message. + */ + warning: any; +} +/** + * Contains a list of node types. + */ +export interface Schema$NodeTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id: string; + /** + * A list of NodeType resources. + */ + items: Schema$NodeType[]; + /** + * [Output Only] Type of resource.Always compute#nodeTypeList for lists of + * node types. + */ + kind: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use the + * nextPageToken as a value for the query parameter pageToken in the next list + * request. Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink: string; + /** + * [Output Only] Informational warning message. + */ + warning: any; +} +export interface Schema$NodeTypesScopedList { + /** + * [Output Only] A list of node types contained in this scope. + */ + nodeTypes: Schema$NodeType[]; + /** + * [Output Only] An informational warning that appears when the node types + * list is empty. + */ + warning: any; +} /** * An Operation resource, used to manage asynchronous API requests. (== * resource_for v1.globalOperations ==) (== resource_for beta.globalOperations @@ -7520,7 +7781,7 @@ export interface Schema$OperationList { } export interface Schema$OperationsScopedList { /** - * [Output Only] List of operations contained in this scope. + * [Output Only] A list of operations contained in this scope. */ operations: Schema$Operation[]; /** @@ -8047,7 +8308,7 @@ export interface Schema$RegionInstanceGroupManagersListInstanceConfigsResp { } export interface Schema$RegionInstanceGroupManagersListInstancesResponse { /** - * List of managed instances. + * A list of managed instances. */ managedInstances: Schema$ManagedInstance[]; /** @@ -8424,7 +8685,7 @@ export interface Schema$Router { */ name: string; /** - * List of Nat services created in this router. The maximum number of Nat + * A list of Nat services created in this router. The maximum number of Nat * services within a Router is 3 for Alpha. */ nats: Schema$RouterNat[]; @@ -8683,7 +8944,7 @@ export interface Schema$RouterList { */ export interface Schema$RouterNat { /** - * [Output Only] List of IPs allocated automatically by GCP for this Nat + * [Output Only] A list of IPs allocated automatically by GCP for this Nat * service. They will be raw IP strings like "179.12.26.133". They * are ephemeral IPs allocated from the IP blocks managed by the NAT manager. * This list can grow and shrink based on the number of VMs configured to use @@ -8701,9 +8962,9 @@ export interface Schema$RouterNat { */ natIpAllocateOption: string; /** - * List of URLs of the IP resources used for this Nat service. These IPs must - * be valid static external IP addresses assigned to the project. max_length - * is subject to change post alpha. + * A list of URLs of the IP resources used for this Nat service. These IPs + * must be valid static external IP addresses assigned to the project. + * max_length is subject to change post alpha. */ natIps: string[]; /** @@ -8714,7 +8975,7 @@ export interface Schema$RouterNat { */ sourceSubnetworkIpRangesToNat: string; /** - * List of Subnetwork resources whose traffic should be translated by NAT + * A list of Subnetwork resources whose traffic should be translated by NAT * Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the * SubnetworkIpRangeToNatOption above. */ @@ -8729,9 +8990,9 @@ export interface Schema$RouterNatSubnetworkToNat { */ name: string; /** - * List of the secondary ranges of the Subnetwork that are allowed to use NAT. - * This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is - * one of the values in source_ip_ranges_to_nat. + * A list of the secondary ranges of the Subnetwork that are allowed to use + * NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" + * is one of the values in source_ip_ranges_to_nat. */ secondaryIpRangeNames: string[]; /** @@ -8750,7 +9011,7 @@ export interface Schema$RoutersPreviewResponse { } export interface Schema$RoutersScopedList { /** - * List of routers contained in this scope. + * A list of routers contained in this scope. */ routers: Schema$Router[]; /** @@ -8823,7 +9084,7 @@ export interface Schema$RouterStatusBgpPeerStatus { */ export interface Schema$RouterStatusNatStatus { /** - * List of IPs auto-allocated for NAT. Example: ["1.1.1.1", + * A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", * "129.2.16.89"] */ autoAllocatedNatIps: string[]; @@ -8843,11 +9104,11 @@ export interface Schema$RouterStatusNatStatus { */ numVmEndpointsWithNatMappings: number; /** - * List of fully qualified URLs of reserved IP address resources. + * A list of fully qualified URLs of reserved IP address resources. */ userAllocatedNatIpResources: string[]; /** - * List of IPs user-allocated for NAT. They will be raw IP strings like + * A list of IPs user-allocated for NAT. They will be raw IP strings like * "179.12.26.133". */ userAllocatedNatIps: string[]; @@ -8991,7 +9252,7 @@ export interface Schema$SecurityPolicy { */ name: string; /** - * List of rules that belong to this policy. There must always be a default + * A list of rules that belong to this policy. There must always be a default * rule (rule with priority 2147483647 and match "*"). If no rules * are provided when creating a security policy, a default rule with action * "allow" will be added. @@ -9488,7 +9749,7 @@ export interface Schema$SslCertificateManagedSslCertificate { status: string; } /** - * Configuration and status of a self-managed SSL certificate.. + * Configuration and status of a self-managed SSL certificate. */ export interface Schema$SslCertificateSelfManagedSslCertificate { /** @@ -9590,9 +9851,9 @@ export interface Schema$SslPolicy { */ creationTimestamp: string; /** - * List of features enabled when the selected profile is CUSTOM. The - method - * returns the set of features that can be specified in this list. This field - * must be empty if the profile is not CUSTOM. + * A list of features enabled when the selected profile is CUSTOM. The - + * method returns the set of features that can be specified in this list. This + * field must be empty if the profile is not CUSTOM. */ customFeatures: string[]; /** @@ -9624,7 +9885,7 @@ export interface Schema$SslPolicy { /** * The minimum version of SSL protocol that can be used by the clients to * establish a connection with the load balancer. This can be one of TLS_1_0, - * TLS_1_1, TLS_1_2, TLS_1_3. + * TLS_1_1, TLS_1_2. */ minTlsVersion: string; /** @@ -9901,7 +10162,7 @@ export interface Schema$SubnetworksExpandIpCidrRangeRequest { } export interface Schema$SubnetworksScopedList { /** - * List of subnetworks contained in this scope. + * A list of subnetworks contained in this scope. */ subnetworks: Schema$Subnetwork[]; /** @@ -9933,7 +10194,7 @@ export interface Schema$Tags { } export interface Schema$TargetHttpProxiesScopedList { /** - * List of TargetHttpProxies contained in this scope. + * A list of TargetHttpProxies contained in this scope. */ targetHttpProxies: Schema$TargetHttpProxy[]; /** @@ -10300,7 +10561,7 @@ export interface Schema$TargetInstanceList { } export interface Schema$TargetInstancesScopedList { /** - * List of target instances contained in this scope. + * A list of target instances contained in this scope. */ targetInstances: Schema$TargetInstance[]; /** @@ -10510,7 +10771,7 @@ export interface Schema$TargetPoolsRemoveInstanceRequest { } export interface Schema$TargetPoolsScopedList { /** - * List of target pools contained in this scope. + * A list of target pools contained in this scope. */ targetPools: Schema$TargetPool[]; /** @@ -10876,7 +11137,7 @@ export interface Schema$TargetVpnGatewayList { } export interface Schema$TargetVpnGatewaysScopedList { /** - * [Output Only] List of target vpn gateways contained in this scope. + * [Output Only] A list of target vpn gateways contained in this scope. */ targetVpnGateways: Schema$TargetVpnGateway[]; /** @@ -11194,16 +11455,6 @@ export interface Schema$UsageExportLocation { */ reportNamePrefix: string; } -/** - * A Vm Maintenance Policy specifies what kind of infrastructure maintenance we - * are allowed to perform on this VM and when. - */ -export interface Schema$VmMaintenancePolicy { - /** - * Maintenance windows that are applied to VMs covered by this policy. - */ - maintenanceWindow: Schema$MaintenanceWindow; -} /** * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for * v1.vpnTunnels ==) @@ -11375,7 +11626,7 @@ export interface Schema$VpnTunnelList { } export interface Schema$VpnTunnelsScopedList { /** - * List of vpn tunnels contained in this scope. + * A list of vpn tunnels contained in this scope. */ vpnTunnels: Schema$VpnTunnel[]; /** @@ -19839,7 +20090,7 @@ export class Resource$Instancegroupmanagers { /** * compute.instanceGroupManagers.deletePerInstanceConfigs - * @desc Delete selected per-instance configs for the managed instance group. + * @desc Deletes selected per-instance configs for the managed instance group. * @alias compute.instanceGroupManagers.deletePerInstanceConfigs * @memberOf! () * @@ -19899,7 +20150,7 @@ export class Resource$Instancegroupmanagers { /** * compute.instanceGroupManagers.get * @desc Returns all of the details about the specified managed instance - * group. Get a list of available managed instance groups by making a list() + * group. Gets a list of available managed instance groups by making a list() * request. * @alias compute.instanceGroupManagers.get * @memberOf! () @@ -21570,68 +21821,6 @@ export class Resource$Instances { } - /** - * compute.instances.addMaintenancePolicies - * @desc Adds existing maintenance policies to an instance. You can only add - * one policy right now which will be applied to this instance for scheduling - * live migrations. - * @alias compute.instances.addMaintenancePolicies - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.instance The instance name for this request. - * @param {string} params.project Project ID for this request. - * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone for this request. - * @param {().InstancesAddMaintenancePoliciesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - addMaintenancePolicies(params?: any, options?: MethodOptions): - AxiosPromise; - addMaintenancePolicies( - params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - addMaintenancePolicies( - params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - if (typeof options === 'function') { - callback = options; - options = {}; - } - if (typeof params === 'function') { - callback = params; - params = {}; - } - options = options || {}; - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/addMaintenancePolicies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** * compute.instances.aggregatedList * @desc Retrieves aggregated list of instances. @@ -22354,66 +22543,6 @@ export class Resource$Instances { } - /** - * compute.instances.removeMaintenancePolicies - * @desc Removes maintenance policies from an instance. - * @alias compute.instances.removeMaintenancePolicies - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.instance The instance name for this request. - * @param {string} params.project Project ID for this request. - * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone for this request. - * @param {().InstancesRemoveMaintenancePoliciesRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - removeMaintenancePolicies(params?: any, options?: MethodOptions): - AxiosPromise; - removeMaintenancePolicies( - params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - removeMaintenancePolicies( - params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - if (typeof options === 'function') { - callback = options; - options = {}; - } - if (typeof params === 'function') { - callback = params; - params = {}; - } - options = options || {}; - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/removeMaintenancePolicies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['project', 'zone', 'instance'], - pathParams: ['instance', 'project', 'zone'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** * compute.instances.reset * @desc Performs a reset on the instance. For more information, see Resetting @@ -23890,7 +24019,7 @@ export class Resource$Instancetemplates { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Get a list of available + * @desc Returns the specified instance template. Gets a list of available * instance templates by making a list() request. * @alias compute.instanceTemplates.get * @memberOf! () @@ -26191,7 +26320,7 @@ export class Resource$Machinetypes { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Get a list of available machine + * @desc Returns the specified machine type. Gets a list of available machine * types by making a list() request. * @alias compute.machineTypes.get * @memberOf! () @@ -26305,7 +26434,7 @@ export class Resource$Machinetypes { } } -export class Resource$Maintenancepolicies { +export class Resource$Networkendpointgroups { root: Compute; constructor(root: Compute) { this.root = root; @@ -26318,9 +26447,9 @@ export class Resource$Maintenancepolicies { /** - * compute.maintenancePolicies.aggregatedList - * @desc Retrieves an aggregated list of maintenance policies. - * @alias compute.maintenancePolicies.aggregatedList + * compute.networkEndpointGroups.aggregatedList + * @desc Retrieves the list of network endpoint groups and sorts them by zone. + * @alias compute.networkEndpointGroups.aggregatedList * @memberOf! () * * @param {object} params Parameters for request @@ -26334,19 +26463,21 @@ export class Resource$Maintenancepolicies { * @return {object} Request object */ aggregatedList(params?: any, options?: MethodOptions): - AxiosPromise; + AxiosPromise; aggregatedList( params?: any, options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): + BodyResponseCallback, + callback?: + BodyResponseCallback): void; aggregatedList( params?: any, options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -26362,7 +26493,7 @@ export class Resource$Maintenancepolicies { { url: (rootUrl + - '/compute/alpha/projects/{project}/aggregated/maintenancePolicies') + '/compute/alpha/projects/{project}/aggregated/networkEndpointGroups') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, @@ -26373,26 +26504,90 @@ export class Resource$Maintenancepolicies { context: this.getRoot() }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback); } else { - return createAPIRequest( + return createAPIRequest( parameters); } } /** - * compute.maintenancePolicies.delete - * @desc Deletes the specified maintenance policy. - * @alias compute.maintenancePolicies.delete + * compute.networkEndpointGroups.attachNetworkEndpoints + * @desc Attach a list of network endpoints to the specified network endpoint + * group. + * @alias compute.networkEndpointGroups.attachNetworkEndpoints * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.maintenancePolicy Name of the maintenance policy to delete. + * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {().NetworkEndpointGroupsAttachEndpointsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + attachNetworkEndpoints(params?: any, options?: MethodOptions): + AxiosPromise; + attachNetworkEndpoints( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + attachNetworkEndpoints( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * 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. + * @alias compute.networkEndpointGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group to delete. It should comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -26422,14 +26617,14 @@ export class Resource$Maintenancepolicies { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/maintenancePolicies/{maintenancePolicy}') + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}') .replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE' }, options), params, - requiredParams: ['project', 'region', 'maintenancePolicy'], - pathParams: ['maintenancePolicy', 'project', 'region'], + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], context: this.getRoot() }; if (callback) { @@ -26441,28 +26636,33 @@ export class Resource$Maintenancepolicies { /** - * compute.maintenancePolicies.get - * @desc Retrieves all information of the specified maintenance policy. - * @alias compute.maintenancePolicies.get + * compute.networkEndpointGroups.detachNetworkEndpoints + * @desc Detach a list of network endpoints from the specified network + * endpoint group. + * @alias compute.networkEndpointGroups.detachNetworkEndpoints * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.maintenancePolicy Name of the maintenance policy to retrieve. + * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {().NetworkEndpointGroupsDetachEndpointsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get(params?: any, - options?: MethodOptions): AxiosPromise; - get(params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - get(params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + detachNetworkEndpoints(params?: any, options?: MethodOptions): + AxiosPromise; + detachNetworkEndpoints( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + detachNetworkEndpoints( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -26478,48 +26678,48 @@ export class Resource$Maintenancepolicies { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/maintenancePolicies/{maintenancePolicy}') + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints') .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + method: 'POST' }, options), params, - requiredParams: ['project', 'region', 'maintenancePolicy'], - pathParams: ['maintenancePolicy', 'project', 'region'], + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.maintenancePolicies.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. - * @alias compute.maintenancePolicies.getIamPolicy + * compute.networkEndpointGroups.get + * @desc Returns the specified network endpoint group. Get a list of available + * network endpoint groups by making a list() request. + * @alias compute.networkEndpointGroups.get * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.networkEndpointGroup The name of the network endpoint group. It should comply with RFC1035. * @param {string} params.project Project ID for this request. - * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getIamPolicy(params?: any, options?: MethodOptions): - AxiosPromise; - getIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - getIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + get(params?: any, + options?: MethodOptions): AxiosPromise; + get(params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + get(params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -26535,35 +26735,36 @@ export class Resource$Maintenancepolicies { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/maintenancePolicies/{resource}/getIamPolicy') + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.maintenancePolicies.insert - * @desc Creates a new maintenance policy. - * @alias compute.maintenancePolicies.insert + * compute.networkEndpointGroups.insert + * @desc Creates a network endpoint group in the specified project using the + * parameters that are included in the request. + * @alias compute.networkEndpointGroups.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 {().MaintenancePolicy} params.resource Request body data + * @param {string} params.zone The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. + * @param {().NetworkEndpointGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -26593,14 +26794,14 @@ export class Resource$Maintenancepolicies { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/maintenancePolicies') + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.getRoot() }; if (callback) { @@ -26612,10 +26813,10 @@ export class Resource$Maintenancepolicies { /** - * compute.maintenancePolicies.list - * @desc List all the maintenance policies that have been configured for the - * specified project in specified region. - * @alias compute.maintenancePolicies.list + * compute.networkEndpointGroups.list + * @desc Retrieves the list of network endpoint groups that are located in the + * specified project and zone. + * @alias compute.networkEndpointGroups.list * @memberOf! () * * @param {object} params Parameters for request @@ -26624,24 +26825,24 @@ export class Resource$Maintenancepolicies { * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. - * @param {string} params.region Name of the region for this request. + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: any, options?: MethodOptions): - AxiosPromise; + AxiosPromise; list( params?: any, options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): void; + BodyResponseCallback, + callback?: BodyResponseCallback): void; list( params?: any, options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -26657,49 +26858,58 @@ export class Resource$Maintenancepolicies { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/maintenancePolicies') + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.maintenancePolicies.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias compute.maintenancePolicies.setIamPolicy + * compute.networkEndpointGroups.listNetworkEndpoints + * @desc Lists the network endpoints in the specified network endpoint group. + * @alias compute.networkEndpointGroups.listNetworkEndpoints * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.networkEndpointGroup The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. - * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. - * @param {().Policy} params.resource Request body data + * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {().NetworkEndpointGroupsListEndpointsRequest} params.resource Request body data * @param {object} [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?: any, options?: MethodOptions): - AxiosPromise; - setIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - setIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + listNetworkEndpoints(params?: any, options?: MethodOptions): + AxiosPromise; + listNetworkEndpoints( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints>): void; + listNetworkEndpoints( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints>): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -26715,34 +26925,36 @@ export class Resource$Maintenancepolicies { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/maintenancePolicies/{resource}/setIamPolicy') + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'zone', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters); } } /** - * compute.maintenancePolicies.testIamPermissions + * compute.networkEndpointGroups.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. - * @alias compute.maintenancePolicies.testIamPermissions + * @alias compute.networkEndpointGroups.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. - * @param {string} params.region The name of the region for this request. * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -26776,14 +26988,14 @@ export class Resource$Maintenancepolicies { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/maintenancePolicies/{resource}/testIamPermissions') + '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.getRoot() }; if (callback) { @@ -26794,7 +27006,7 @@ export class Resource$Maintenancepolicies { } } -export class Resource$Networkendpointgroups { +export class Resource$Networks { root: Compute; constructor(root: Compute) { this.root = root; @@ -26807,37 +27019,31 @@ export class Resource$Networkendpointgroups { /** - * compute.networkEndpointGroups.aggregatedList - * @desc Retrieves the list of network endpoint groups and sorts them by zone. - * @alias compute.networkEndpointGroups.aggregatedList + * compute.networks.addPeering + * @desc Adds a peering to the specified network. + * @alias compute.networks.addPeering * @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.network Name of the network resource to add peering to. * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NetworksAddPeeringRequest} params.resource Request body data * @param {object} [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?: any, options?: MethodOptions): - AxiosPromise; - aggregatedList( + addPeering(params?: any, options?: MethodOptions): + AxiosPromise; + addPeering( params?: any, - options?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void; - aggregatedList( + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + addPeering( params?: any, - options?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -26853,50 +27059,44 @@ export class Resource$Networkendpointgroups { { url: (rootUrl + - '/compute/alpha/projects/{project}/aggregated/networkEndpointGroups') + '/compute/alpha/projects/{project}/global/networks/{network}/addPeering') .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + method: 'POST' }, options), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.getRoot() }; if (callback) { - createAPIRequest( - parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters); + return createAPIRequest(parameters); } } /** - * compute.networkEndpointGroups.attachNetworkEndpoints - * @desc Attach a list of network endpoints to the specified network endpoint - * group. - * @alias compute.networkEndpointGroups.attachNetworkEndpoints + * compute.networks.delete + * @desc Deletes the specified network. + * @alias compute.networks.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + * @param {string} params.network Name of the network to delete. * @param {string} params.project Project ID for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * @param {().NetworkEndpointGroupsAttachEndpointsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - attachNetworkEndpoints(params?: any, options?: MethodOptions): - AxiosPromise; - attachNetworkEndpoints( + delete(params?: any, options?: MethodOptions): AxiosPromise; + delete( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void; - attachNetworkEndpoints( + delete( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): @@ -26914,16 +27114,15 @@ export class Resource$Networkendpointgroups { const parameters = { options: Object.assign( { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + url: (rootUrl + + '/compute/alpha/projects/{project}/global/networks/{network}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' }, options), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.getRoot() }; if (callback) { @@ -26935,29 +27134,80 @@ export class Resource$Networkendpointgroups { /** - * 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. - * @alias compute.networkEndpointGroups.delete + * compute.networks.get + * @desc Returns the specified network. Get a list of available networks by + * making a list() request. + * @alias compute.networks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.network Name of the network to return. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: any, options?: MethodOptions): AxiosPromise; + get(params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + get(params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/alpha/projects/{project}/global/networks/{network}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.networks.insert + * @desc Creates a network in the specified project using the data included in + * the request. + * @alias compute.networks.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.networkEndpointGroup The name of the network endpoint group to delete. It should comply with RFC1035. * @param {string} params.project Project ID for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {().Network} params.resource Request body data * @param {object} [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?: any, options?: MethodOptions): AxiosPromise; - delete( + insert(params?: any, options?: MethodOptions): AxiosPromise; + insert( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void; - delete( + insert( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): @@ -26975,16 +27225,14 @@ export class Resource$Networkendpointgroups { const parameters = { options: Object.assign( { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' + url: (rootUrl + '/compute/alpha/projects/{project}/global/networks') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' }, options), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.getRoot() }; if (callback) { @@ -26996,33 +27244,31 @@ export class Resource$Networkendpointgroups { /** - * compute.networkEndpointGroups.detachNetworkEndpoints - * @desc Detach a list of network endpoints from the specified network - * endpoint group. - * @alias compute.networkEndpointGroups.detachNetworkEndpoints + * compute.networks.list + * @desc Retrieves the list of networks available to the specified project. + * @alias compute.networks.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.networkEndpointGroup The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. + * @param {string=} params.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.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * @param {().NetworkEndpointGroupsDetachEndpointsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - detachNetworkEndpoints(params?: any, options?: MethodOptions): - AxiosPromise; - detachNetworkEndpoints( + list(params?: any, options?: MethodOptions): AxiosPromise; + list( params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - detachNetworkEndpoints( + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + list( params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -27036,50 +27282,57 @@ export class Resource$Networkendpointgroups { const parameters = { options: Object.assign( { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + url: (rootUrl + '/compute/alpha/projects/{project}/global/networks') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' }, options), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project'], + pathParams: ['project'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.networkEndpointGroups.get - * @desc Returns the specified network endpoint group. Get a list of available - * network endpoint groups by making a list() request. - * @alias compute.networkEndpointGroups.get + * compute.networks.listIpOwners + * @desc Lists the internal IP owners in the specified network. + * @alias compute.networks.listIpOwners * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.networkEndpointGroup The name of the network endpoint group. It should comply with RFC1035. + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {string=} params.ipCidrRange (Optional) IP CIDR range filter, example: "10.128.10.0/30". + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.network Name of the network to return. + * @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.ownerProjects (Optional) Project IDs filter, example: "project-1,project-2". + * @param {string=} params.ownerTypes (Optional) Owner types filter, example: "instance,forwardingRule". + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. - * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {string=} params.subnetName (Optional) Subnetwork name filter. + * @param {string=} params.subnetRegion (Optional) Subnetwork region filter. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get(params?: any, - options?: MethodOptions): AxiosPromise; - get(params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - get(params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + listIpOwners(params?: any, options?: MethodOptions): + AxiosPromise; + listIpOwners( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + listIpOwners( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -27095,46 +27348,46 @@ export class Resource$Networkendpointgroups { { url: (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}') + '/compute/alpha/projects/{project}/global/networks/{network}/listIpOwners') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.networkEndpointGroups.insert - * @desc Creates a network endpoint group in the specified project using the - * parameters that are included in the request. - * @alias compute.networkEndpointGroups.insert + * compute.networks.patch + * @desc Patches the specified network with the data included in the request. + * Only the following fields can be modified: routingConfig.routingMode. + * @alias compute.networks.patch * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.network Name of the network to update. * @param {string} params.project Project ID for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. - * @param {().NetworkEndpointGroup} params.resource Request body data + * @param {().Network} params.resource Request body data * @param {object} [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?: any, options?: MethodOptions): AxiosPromise; - insert( + patch(params?: any, options?: MethodOptions): AxiosPromise; + patch( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void; - insert( + patch( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): @@ -27152,16 +27405,15 @@ export class Resource$Networkendpointgroups { const parameters = { options: Object.assign( { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + url: (rootUrl + + '/compute/alpha/projects/{project}/global/networks/{network}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' }, options), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.getRoot() }; if (callback) { @@ -27173,36 +27425,31 @@ export class Resource$Networkendpointgroups { /** - * compute.networkEndpointGroups.list - * @desc Retrieves the list of network endpoint groups that are located in the - * specified project and zone. - * @alias compute.networkEndpointGroups.list + * compute.networks.removePeering + * @desc Removes a peering from the specified network. + * @alias compute.networks.removePeering * @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.network Name of the network resource to remove peering from. * @param {string} params.project Project ID for this request. - * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NetworksRemovePeeringRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list(params?: any, options?: MethodOptions): - AxiosPromise; - list( + removePeering(params?: any, options?: MethodOptions): + AxiosPromise; + removePeering( params?: any, - options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): void; - list( + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + removePeering( params?: any, - options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -27218,58 +27465,50 @@ export class Resource$Networkendpointgroups { { url: (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups') + '/compute/alpha/projects/{project}/global/networks/{network}/removePeering') .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + method: 'POST' }, options), params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.networkEndpointGroups.listNetworkEndpoints - * @desc List the network endpoints in the specified network endpoint group. - * @alias compute.networkEndpointGroups.listNetworkEndpoints + * compute.networks.switchToCustomMode + * @desc Switches the network mode from auto subnet mode to custom subnet + * mode. + * @alias compute.networks.switchToCustomMode * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). - * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) - * @param {string} params.networkEndpointGroup The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. - * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. - * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.network Name of the network to be updated. * @param {string} params.project Project ID for this request. - * @param {string} params.zone The name of the zone where the network endpoint group is located. It should comply with RFC1035. - * @param {().NetworkEndpointGroupsListEndpointsRequest} params.resource Request body data + * @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 */ - listNetworkEndpoints(params?: any, options?: MethodOptions): - AxiosPromise; - listNetworkEndpoints( + switchToCustomMode(params?: any, options?: MethodOptions): + AxiosPromise; + switchToCustomMode( params?: any, - options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$NetworkEndpointGroupsListNetworkEndpoints>): void; - listNetworkEndpoints( + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + switchToCustomMode( params?: any, - options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$NetworkEndpointGroupsListNetworkEndpoints>): - void|AxiosPromise { + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -27285,36 +27524,33 @@ export class Resource$Networkendpointgroups { { url: (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints') + '/compute/alpha/projects/{project}/global/networks/{network}/switchToCustomMode') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'zone', 'networkEndpointGroup'], - pathParams: ['networkEndpointGroup', 'project', 'zone'], + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], context: this.getRoot() }; if (callback) { - createAPIRequest( - parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters); + return createAPIRequest(parameters); } } /** - * compute.networkEndpointGroups.testIamPermissions + * compute.networks.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. - * @alias compute.networkEndpointGroups.testIamPermissions + * @alias compute.networks.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.resource_ Name of the resource for this request. - * @param {string} params.zone The name of the zone for this request. * @param {().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. @@ -27348,14 +27584,14 @@ export class Resource$Networkendpointgroups { { url: (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions') + '/compute/alpha/projects/{project}/global/networks/{resource}/testIamPermissions') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], context: this.getRoot() }; if (callback) { @@ -27366,7 +27602,7 @@ export class Resource$Networkendpointgroups { } } -export class Resource$Networks { +export class Resource$Nodegroups { root: Compute; constructor(root: Compute) { this.root = root; @@ -27379,27 +27615,28 @@ export class Resource$Networks { /** - * compute.networks.addPeering - * @desc Adds a peering to the specified network. - * @alias compute.networks.addPeering + * compute.nodeGroups.addNodes + * @desc Adds specified number of nodes to the node group. + * @alias compute.nodeGroups.addNodes * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.network Name of the network resource to add peering to. + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. * @param {string} params.project Project ID for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {().NetworksAddPeeringRequest} params.resource Request body data + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroupsAddNodesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - addPeering(params?: any, options?: MethodOptions): + addNodes(params?: any, options?: MethodOptions): AxiosPromise; - addPeering( + addNodes( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void; - addPeering( + addNodes( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): @@ -27419,14 +27656,14 @@ export class Resource$Networks { { url: (rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/addPeering') + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.getRoot() }; if (callback) { @@ -27438,23 +27675,85 @@ export class Resource$Networks { /** - * compute.networks.delete - * @desc Deletes the specified network. - * @alias compute.networks.delete + * compute.nodeGroups.aggregatedList + * @desc Retrieves an aggregated list of node groups. + * @alias compute.nodeGroups.aggregatedList * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.network Name of the network to delete. + * @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.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?: any, options?: MethodOptions): AxiosPromise; - delete( + aggregatedList(params?: any, options?: MethodOptions): + AxiosPromise; + aggregatedList( params?: any, - options?: MethodOptions|BodyResponseCallback, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): void; + aggregatedList( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/alpha/projects/{project}/aggregated/nodeGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.delete + * @desc Deletes the specified NodeGroup resource. + * @alias compute.nodeGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: any, options?: MethodOptions): AxiosPromise; + delete( + params?: any, + options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void; delete( params?: any, @@ -27474,15 +27773,16 @@ export class Resource$Networks { const parameters = { options: Object.assign( { - url: (rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}') - .replace(/([^:]\/)\/+/g, '$1'), + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}') + .replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE' }, options), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.getRoot() }; if (callback) { @@ -27494,27 +27794,88 @@ export class Resource$Networks { /** - * compute.networks.get - * @desc Returns the specified network. Get a list of available networks by - * making a list() request. - * @alias compute.networks.get + * compute.nodeGroups.deleteNodes + * @desc Deletes specified nodes from the node group. + * @alias compute.nodeGroups.deleteNodes * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.network Name of the network to return. + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroupsDeleteNodesRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get(params?: any, options?: MethodOptions): AxiosPromise; + deleteNodes(params?: any, options?: MethodOptions): + AxiosPromise; + deleteNodes( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + deleteNodes( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.get + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups + * by making a list() request. + * @alias compute.nodeGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the node group to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: any, options?: MethodOptions): AxiosPromise; get(params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; get(params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -27528,36 +27889,96 @@ export class Resource$Networks { const parameters = { options: Object.assign( { - url: (rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}') - .replace(/([^:]\/)\/+/g, '$1'), + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}') + .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.networks.insert - * @desc Creates a network in the specified project using the data included in - * the request. - * @alias compute.networks.insert + * compute.nodeGroups.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no + * such policy or resource exists. + * @alias compute.nodeGroups.getIamPolicy * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy(params?: any, options?: MethodOptions): + AxiosPromise; + getIamPolicy( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + getIamPolicy( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.insert + * @desc Creates a NodeGroup resource in the specified project using the data + * included in the request. + * @alias compute.nodeGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer} params.initialNodeCount Initial count of nodes in the node group. + * @param {string} params.project Project ID for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {().Network} params.resource Request body data + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroup} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -27585,14 +28006,15 @@ export class Resource$Networks { const parameters = { options: Object.assign( { - url: (rootUrl + '/compute/alpha/projects/{project}/global/networks') + url: (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone', 'initialNodeCount'], + pathParams: ['project', 'zone'], context: this.getRoot() }; if (callback) { @@ -27604,9 +28026,9 @@ export class Resource$Networks { /** - * compute.networks.list - * @desc Retrieves the list of networks available to the specified project. - * @alias compute.networks.list + * compute.nodeGroups.list + * @desc Retrieves a list of node groups available to the specified project. + * @alias compute.nodeGroups.list * @memberOf! () * * @param {object} params Parameters for request @@ -27615,20 +28037,22 @@ export class Resource$Networks { * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list(params?: any, options?: MethodOptions): AxiosPromise; + list(params?: any, options?: MethodOptions): + AxiosPromise; list( params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; list( params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -27642,57 +28066,50 @@ export class Resource$Networks { const parameters = { options: Object.assign( { - url: (rootUrl + '/compute/alpha/projects/{project}/global/networks') + url: (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.networks.listIpOwners - * @desc List the internal IP owners in the specified network. - * @alias compute.networks.listIpOwners + * compute.nodeGroups.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias compute.nodeGroups.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). - * @param {string=} params.ipCidrRange (Optional) IP CIDR range filter, example: "10.128.10.0/30". - * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) - * @param {string} params.network Name of the network to return. - * @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.ownerProjects (Optional) Project IDs filter, example: "project-1,project-2". - * @param {string=} params.ownerTypes (Optional) Owner types filter, example: "instance,forwardingRule". - * @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.subnetName (Optional) Subnetwork name filter. - * @param {string=} params.subnetRegion (Optional) Subnetwork region filter. + * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {().Policy} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - listIpOwners(params?: any, options?: MethodOptions): - AxiosPromise; - listIpOwners( - params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - listIpOwners( - params?: any, - options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + setIamPolicy(params?: any, options?: MethodOptions): + AxiosPromise; + setIamPolicy( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + setIamPolicy( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -27708,46 +28125,47 @@ export class Resource$Networks { { url: (rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/listIpOwners') + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy') .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + method: 'POST' }, options), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.networks.patch - * @desc Patches the specified network with the data included in the request. - * Only the following fields can be modified: routingConfig.routingMode. - * @alias compute.networks.patch + * compute.nodeGroups.setNodeTemplate + * @desc Updates the node template of the node group. + * @alias compute.nodeGroups.setNodeTemplate * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.network Name of the network to update. + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. * @param {string} params.project Project ID for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {().Network} params.resource Request body data + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroupsSetNodeTemplateRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - patch(params?: any, options?: MethodOptions): AxiosPromise; - patch( + setNodeTemplate(params?: any, options?: MethodOptions): + AxiosPromise; + setNodeTemplate( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void; - patch( + setNodeTemplate( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): @@ -27765,15 +28183,16 @@ export class Resource$Networks { const parameters = { options: Object.assign( { - url: (rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' }, options), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], context: this.getRoot() }; if (callback) { @@ -27785,27 +28204,160 @@ export class Resource$Networks { /** - * compute.networks.removePeering - * @desc Removes a peering from the specified network. - * @alias compute.networks.removePeering + * compute.nodeGroups.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.nodeGroups.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.network Name of the network resource to remove peering from. * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {().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?: any, options?: MethodOptions): + AxiosPromise; + testIamPermissions( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): void; + testIamPermissions( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } +} + +export class Resource$Nodetemplates { + root: Compute; + constructor(root: Compute) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * compute.nodeTemplates.aggregatedList + * @desc Retrieves an aggregated list of node templates. + * @alias compute.nodeTemplates.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList(params?: any, options?: MethodOptions): + AxiosPromise; + aggregatedList( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): void; + aggregatedList( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/alpha/projects/{project}/aggregated/nodeTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.delete + * @desc Deletes the specified NodeTemplate resource. + * @alias compute.nodeTemplates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeTemplate Name of the NodeTemplate resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {().NetworksRemovePeeringRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - removePeering(params?: any, options?: MethodOptions): - AxiosPromise; - removePeering( + delete(params?: any, options?: MethodOptions): AxiosPromise; + delete( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void; - removePeering( + delete( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): @@ -27825,14 +28377,14 @@ export class Resource$Networks { { url: (rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/removePeering') + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}') .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + method: 'DELETE' }, options), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'region', 'nodeTemplate'], + pathParams: ['nodeTemplate', 'project', 'region'], context: this.getRoot() }; if (callback) { @@ -27844,27 +28396,140 @@ export class Resource$Networks { /** - * compute.networks.switchToCustomMode - * @desc Switches the network mode from auto subnet mode to custom subnet - * mode. - * @alias compute.networks.switchToCustomMode + * compute.nodeTemplates.get + * @desc Returns the specified node template. Get a list of available node + * templates by making a list() request. + * @alias compute.nodeTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeTemplate Name of the node template to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: any, options?: MethodOptions): AxiosPromise; + get(params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + get(params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region', 'nodeTemplate'], + pathParams: ['nodeTemplate', 'project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no + * such policy or resource exists. + * @alias compute.nodeTemplates.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy(params?: any, options?: MethodOptions): + AxiosPromise; + getIamPolicy( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + getIamPolicy( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.insert + * @desc Creates a NodeTemplate resource in the specified project using the + * data included in the request. + * @alias compute.nodeTemplates.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.network Name of the network to be updated. * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NodeTemplate} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - switchToCustomMode(params?: any, options?: MethodOptions): - AxiosPromise; - switchToCustomMode( + insert(params?: any, options?: MethodOptions): AxiosPromise; + insert( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void; - switchToCustomMode( + insert( params?: any, options?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): @@ -27884,14 +28549,14 @@ export class Resource$Networks { { url: (rootUrl + - '/compute/alpha/projects/{project}/global/networks/{network}/switchToCustomMode') + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'network'], - pathParams: ['network', 'project'], + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], context: this.getRoot() }; if (callback) { @@ -27903,13 +28568,134 @@ export class Resource$Networks { /** - * compute.networks.testIamPermissions + * compute.nodeTemplates.list + * @desc Retrieves a list of node templates available to the specified + * project. + * @alias compute.nodeTemplates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: any, options?: MethodOptions): + AxiosPromise; + list( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + list( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias compute.nodeTemplates.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {().Policy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy(params?: any, options?: MethodOptions): + AxiosPromise; + setIamPolicy( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + setIamPolicy( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. - * @alias compute.networks.testIamPermissions + * @alias compute.nodeTemplates.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. * @param {string} params.resource_ Name of the resource for this request. * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -27944,14 +28730,14 @@ export class Resource$Networks { { url: (rootUrl + - '/compute/alpha/projects/{project}/global/networks/{resource}/testIamPermissions') + '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'resource'], - pathParams: ['project', 'resource'], + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], context: this.getRoot() }; if (callback) { @@ -27962,7 +28748,7 @@ export class Resource$Networks { } } -export class Resource$Nodegroups { +export class Resource$Nodetypes { root: Compute; constructor(root: Compute) { this.root = root; @@ -27975,217 +28761,34 @@ export class Resource$Nodegroups { /** - * compute.nodeGroups.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. - * @alias compute.nodeGroups.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. - * @param {string} params.zone The name of the zone for this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getIamPolicy(params?: any, options?: MethodOptions): - AxiosPromise; - getIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - getIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - if (typeof options === 'function') { - callback = options; - options = {}; - } - if (typeof params === 'function') { - callback = params; - params = {}; - } - options = options || {}; - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * compute.nodeGroups.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias compute.nodeGroups.setIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. - * @param {string} params.zone The name of the zone for this request. - * @param {().Policy} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - setIamPolicy(params?: any, options?: MethodOptions): - AxiosPromise; - setIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - setIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - if (typeof options === 'function') { - callback = options; - options = {}; - } - if (typeof params === 'function') { - callback = params; - params = {}; - } - options = options || {}; - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * compute.nodeGroups.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. - * @alias compute.nodeGroups.testIamPermissions + * compute.nodeTypes.aggregatedList + * @desc Retrieves an aggregated list of node types. + * @alias compute.nodeTypes.aggregatedList * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. - * @param {string} params.resource_ Name of the resource for this request. - * @param {string} params.zone The name of the zone for this request. - * @param {().TestPermissionsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - testIamPermissions(params?: any, options?: MethodOptions): - AxiosPromise; - testIamPermissions( + aggregatedList(params?: any, options?: MethodOptions): + AxiosPromise; + aggregatedList( params?: any, options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): void; - testIamPermissions( + BodyResponseCallback, + callback?: BodyResponseCallback): void; + aggregatedList( params?: any, options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - if (typeof options === 'function') { - callback = options; - options = {}; - } - if (typeof params === 'function') { - callback = params; - params = {}; - } - options = options || {}; - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } -} - -export class Resource$Nodetemplates { - root: Compute; - constructor(root: Compute) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * compute.nodeTemplates.getIamPolicy - * @desc Gets the access control policy for a resource. May be empty if no - * such policy or resource exists. - * @alias compute.nodeTemplates.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.project Project ID for this request. - * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - getIamPolicy(params?: any, options?: MethodOptions): - AxiosPromise; - getIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - getIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -28199,51 +28802,48 @@ export class Resource$Nodetemplates { const parameters = { options: Object.assign( { - url: - (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy') - .replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + + '/compute/alpha/projects/{project}/aggregated/nodeTypes') + .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project'], + pathParams: ['project'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.nodeTemplates.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. - * @alias compute.nodeTemplates.setIamPolicy + * compute.nodeTypes.get + * @desc Returns the specified node type. Get a list of available node types + * by making a list() request. + * @alias compute.nodeTypes.get * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.nodeType Name of the node type to return. * @param {string} params.project Project ID for this request. - * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. - * @param {().Policy} params.resource Request body data + * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - setIamPolicy(params?: any, options?: MethodOptions): - AxiosPromise; - setIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): void; - setIamPolicy( - params?: any, options?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + get(params?: any, options?: MethodOptions): AxiosPromise; + get(params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + get(params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -28259,52 +28859,52 @@ export class Resource$Nodetemplates { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy') + '/compute/alpha/projects/{project}/zones/{zone}/nodeTypes/{nodeType}') .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + method: 'GET' }, options), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'zone', 'nodeType'], + pathParams: ['nodeType', 'project', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.nodeTemplates.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. - * @alias compute.nodeTemplates.testIamPermissions + * compute.nodeTypes.list + * @desc Retrieves a list of node types available to the specified project. + * @alias compute.nodeTypes.list * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. - * @param {string} params.region The name of the region for this request. - * @param {string} params.resource_ Name of the resource for this request. - * @param {().TestPermissionsRequest} params.resource Request body data + * @param {string} params.zone The name of the zone for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - testIamPermissions(params?: any, options?: MethodOptions): - AxiosPromise; - testIamPermissions( + list(params?: any, options?: MethodOptions): + AxiosPromise; + list( params?: any, - options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): void; - testIamPermissions( + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + list( params?: any, - options?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { if (typeof options === 'function') { callback = options; options = {}; @@ -28318,22 +28918,21 @@ export class Resource$Nodetemplates { const parameters = { options: Object.assign( { - url: - (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + url: (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeTypes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' }, options), params, - requiredParams: ['project', 'region', 'resource'], - pathParams: ['project', 'region', 'resource'], + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -28630,7 +29229,7 @@ export class Resource$Projects { /** * compute.projects.getXpnHost - * @desc Get the shared VPC host project that this project links to. May be + * @desc Gets the shared VPC host project that this project links to. May be * empty if no link exists. * @alias compute.projects.getXpnHost * @memberOf! () @@ -28685,7 +29284,7 @@ export class Resource$Projects { /** * compute.projects.getXpnResources - * @desc Get service resources (a.k.a service project) associated with this + * @desc Gets service resources (a.k.a service project) associated with this * host project. * @alias compute.projects.getXpnResources * @memberOf! () @@ -28746,7 +29345,7 @@ export class Resource$Projects { /** * compute.projects.listXpnHosts - * @desc List all shared VPC host projects visible to the user in an + * @desc Lists all shared VPC host projects visible to the user in an * organization. * @alias compute.projects.listXpnHosts * @memberOf! () @@ -31706,7 +32305,7 @@ export class Resource$Regioninstancegroupmanagers { /** * compute.regionInstanceGroupManagers.deletePerInstanceConfigs - * @desc Delete selected per-instance configs for the managed instance group. + * @desc Deletes selected per-instance configs for the managed instance group. * @alias compute.regionInstanceGroupManagers.deletePerInstanceConfigs * @memberOf! () * @@ -33364,7 +33963,7 @@ export class Resource$Regiontargethttpproxies { /** * compute.regionTargetHttpProxies.get * @desc Returns the specified TargetHttpProxy resource in the specified - * region. Get a list of available target HTTP proxies by making a list() + * region. Gets a list of available target HTTP proxies by making a list() * request. * @alias compute.regionTargetHttpProxies.get * @memberOf! () @@ -36435,7 +37034,7 @@ export class Resource$Sslpolicies { /** * compute.sslPolicies.get - * @desc List all of the ordered rules present in a single specified policy. + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -36546,8 +37145,8 @@ export class Resource$Sslpolicies { /** * compute.sslPolicies.list - * @desc List 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. * @alias compute.sslPolicies.list * @memberOf! () * diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 3d2dc56ab90..e700132e2df 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -302,7 +302,7 @@ export interface Schema$AcceleratorTypeList { } export interface Schema$AcceleratorTypesScopedList { /** - * [Output Only] List of accelerator types contained in this scope. + * [Output Only] A list of accelerator types contained in this scope. */ acceleratorTypes: Schema$AcceleratorType[]; /** @@ -492,7 +492,7 @@ export interface Schema$AddressAggregatedList { } export interface Schema$AddressesScopedList { /** - * [Output Only] List of addresses contained in this scope. + * [Output Only] A list of addresses contained in this scope. */ addresses: Schema$Address[]; /** @@ -921,7 +921,7 @@ export interface Schema$AutoscalerList { } export interface Schema$AutoscalersScopedList { /** - * [Output Only] List of autoscalers contained in this scope. + * [Output Only] A list of autoscalers contained in this scope. */ autoscalers: Schema$Autoscaler[]; /** @@ -1493,7 +1493,7 @@ export interface Schema$BackendServiceList { } export interface Schema$BackendServicesScopedList { /** - * List of BackendServices contained in this scope. + * A list of BackendServices contained in this scope. */ backendServices: Schema$BackendService[]; /** @@ -1634,7 +1634,7 @@ export interface Schema$Commitment { */ region: string; /** - * List of commitment amounts for particular resources. Note that VCPU and + * A list of commitment amounts for particular resources. Note that VCPU and * MEMORY resource commitments must occur together. */ resources: Schema$ResourceCommitment[]; @@ -1724,7 +1724,7 @@ export interface Schema$CommitmentList { } export interface Schema$CommitmentsScopedList { /** - * [Output Only] List of commitments contained in this scope. + * [Output Only] A list of commitments contained in this scope. */ commitments: Schema$Commitment[]; /** @@ -1778,6 +1778,10 @@ export interface Schema$ConnectionDraining { * Represents a customer-supplied encryption key */ export interface Schema$CustomerEncryptionKey { + /** + * The name of the encryption key that is stored in Google Cloud KMS. + */ + kmsKeyName: string; /** * Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 * base64 to either encrypt or decrypt this resource. @@ -1789,7 +1793,7 @@ export interface Schema$CustomerEncryptionKey { * resource. The key must meet the following requirements before you can * provide it to Compute Engine: - The key is wrapped using a RSA public key * certificate provided by Google. - After being wrapped, the key must be - * encoded in RFC 4648 base64 encoding. Get the RSA public key certificate + * encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate * provided by Google at: * https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem */ @@ -2154,7 +2158,7 @@ export interface Schema$DisksResizeRequest { } export interface Schema$DisksScopedList { /** - * [Output Only] List of disks contained in this scope. + * [Output Only] A list of disks contained in this scope. */ disks: Schema$Disk[]; /** @@ -2278,7 +2282,7 @@ export interface Schema$DiskTypeList { } export interface Schema$DiskTypesScopedList { /** - * [Output Only] List of disk types contained in this scope. + * [Output Only] A list of disk types contained in this scope. */ diskTypes: Schema$DiskType[]; /** @@ -2773,7 +2777,7 @@ export interface Schema$ForwardingRuleList { } export interface Schema$ForwardingRulesScopedList { /** - * List of forwarding rules contained in this scope. + * A list of forwarding rules contained in this scope. */ forwardingRules: Schema$ForwardingRule[]; /** @@ -3482,7 +3486,7 @@ export interface Schema$Instance { */ disks: Schema$AttachedDisk[]; /** - * List of the type and count of accelerator cards attached to the instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators: Schema$AcceleratorConfig[]; /** @@ -3676,8 +3680,8 @@ export interface Schema$InstanceGroup { */ network: string; /** - * The URL of the region where the instance group is located (for regional - * resources). + * [Output Only] The URL of the region where the instance group is located + * (for regional resources). */ region: string; /** @@ -3690,8 +3694,8 @@ export interface Schema$InstanceGroup { */ size: number; /** - * The URL of the subnetwork to which all instances in the instance group - * belong. + * [Output Only] The URL of the subnetwork to which all instances in the + * instance group belong. */ subnetwork: string; /** @@ -4465,7 +4469,7 @@ export interface Schema$InstanceReference { } export interface Schema$InstancesScopedList { /** - * [Output Only] List of instances contained in this scope. + * [Output Only] A list of instances contained in this scope. */ instances: Schema$Instance[]; /** @@ -4485,7 +4489,7 @@ export interface Schema$InstancesSetLabelsRequest { } export interface Schema$InstancesSetMachineResourcesRequest { /** - * List of the type and count of accelerator cards attached to the instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators: Schema$AcceleratorConfig[]; } @@ -4643,7 +4647,7 @@ export interface Schema$Interconnect { */ adminEnabled: boolean; /** - * [Output Only] List of CircuitInfo objects, that describe the individual + * [Output Only] A list of CircuitInfo objects, that describe the individual * circuits in this LAG. */ circuitInfos: Schema$InterconnectCircuitInfo[]; @@ -4662,7 +4666,7 @@ export interface Schema$Interconnect { */ description: string; /** - * [Output Only] List of outages expected for this Interconnect. + * [Output Only] A list of outages expected for this Interconnect. */ expectedOutages: Schema$InterconnectOutageNotification[]; /** @@ -5034,7 +5038,7 @@ export interface Schema$InterconnectAttachmentPrivateInfo { } export interface Schema$InterconnectAttachmentsScopedList { /** - * List of interconnect attachments contained in this scope. + * A list of interconnect attachments contained in this scope. */ interconnectAttachments: Schema$InterconnectAttachment[]; /** @@ -5601,7 +5605,7 @@ export interface Schema$MachineTypeList { } export interface Schema$MachineTypesScopedList { /** - * [Output Only] List of machine types contained in this scope. + * [Output Only] A list of machine types contained in this scope. */ machineTypes: Schema$MachineType[]; /** @@ -5770,7 +5774,7 @@ export interface Schema$Network { */ name: string; /** - * [Output Only] List of network peerings for the resource. + * [Output Only] A list of network peerings for the resource. */ peerings: Schema$NetworkPeering[]; /** @@ -6159,7 +6163,7 @@ export interface Schema$OperationList { } export interface Schema$OperationsScopedList { /** - * [Output Only] List of operations contained in this scope. + * [Output Only] A list of operations contained in this scope. */ operations: Schema$Operation[]; /** @@ -6624,7 +6628,7 @@ export interface Schema$RegionInstanceGroupManagersDeleteInstancesRequest { } export interface Schema$RegionInstanceGroupManagersListInstancesResponse { /** - * List of managed instances. + * A list of managed instances. */ managedInstances: Schema$ManagedInstance[]; /** @@ -7109,6 +7113,14 @@ export interface Schema$RouterBgpPeer { * supported. */ ipAddress: string; + /** + * [Output Only] Type of how the resource/configuration of the BGP peer is + * managed. MANAGED_BY_USER is the default value; MANAGED_BY_ATTACHMENT + * represents an BGP peer that is automatically created for PARTNER + * interconnectAttachment, Google will automatically create/delete this type + * of BGP peer when the PARTNER interconnectAttachment is created/deleted. + */ + managementType: string; /** * Name of this BGP peer. The name must be 1-63 characters long and comply * with RFC1035. @@ -7145,6 +7157,15 @@ export interface Schema$RouterInterface { * a VPN Tunnel or an interconnect attachment. */ linkedVpnTunnel: string; + /** + * [Output Only] Type of how the resource/configuration of the interface is + * managed. MANAGED_BY_USER is the default value; MANAGED_BY_ATTACHMENT + * represents an interface that is automatically created for PARTNER type + * interconnectAttachment, Google will automatically create/update/delete this + * type of interface when the PARTNER interconnectAttachment is + * created/provisioned/deleted. + */ + managementType: string; /** * Name of this interface entry. The name must be 1-63 characters long and * comply with RFC1035. @@ -7192,7 +7213,7 @@ export interface Schema$RoutersPreviewResponse { } export interface Schema$RoutersScopedList { /** - * List of routers contained in this scope. + * A list of routers contained in this scope. */ routers: Schema$Router[]; /** @@ -7376,7 +7397,7 @@ export interface Schema$SecurityPolicy { */ name: string; /** - * List of rules that belong to this policy. There must always be a default + * A list of rules that belong to this policy. There must always be a default * rule (rule with priority 2147483647 and match "*"). If no rules * are provided when creating a security policy, a default rule with action * "allow" will be added. @@ -7868,9 +7889,9 @@ export interface Schema$SslPolicy { */ creationTimestamp: string; /** - * List of features enabled when the selected profile is CUSTOM. The - method - * returns the set of features that can be specified in this list. This field - * must be empty if the profile is not CUSTOM. + * A list of features enabled when the selected profile is CUSTOM. The - + * method returns the set of features that can be specified in this list. This + * field must be empty if the profile is not CUSTOM. */ customFeatures: string[]; /** @@ -7902,7 +7923,7 @@ export interface Schema$SslPolicy { /** * The minimum version of SSL protocol that can be used by the clients to * establish a connection with the load balancer. This can be one of TLS_1_0, - * TLS_1_1, TLS_1_2, TLS_1_3. + * TLS_1_1, TLS_1_2. */ minTlsVersion: string; /** @@ -8133,7 +8154,7 @@ export interface Schema$SubnetworksExpandIpCidrRangeRequest { } export interface Schema$SubnetworksScopedList { /** - * List of subnetworks contained in this scope. + * A list of subnetworks contained in this scope. */ subnetworks: Schema$Subnetwork[]; /** @@ -8485,7 +8506,7 @@ export interface Schema$TargetInstanceList { } export interface Schema$TargetInstancesScopedList { /** - * List of target instances contained in this scope. + * A list of target instances contained in this scope. */ targetInstances: Schema$TargetInstance[]; /** @@ -8695,7 +8716,7 @@ export interface Schema$TargetPoolsRemoveInstanceRequest { } export interface Schema$TargetPoolsScopedList { /** - * List of target pools contained in this scope. + * A list of target pools contained in this scope. */ targetPools: Schema$TargetPool[]; /** @@ -9061,7 +9082,7 @@ export interface Schema$TargetVpnGatewayList { } export interface Schema$TargetVpnGatewaysScopedList { /** - * [Output Only] List of target vpn gateways contained in this scope. + * [Output Only] A list of target vpn gateways contained in this scope. */ targetVpnGateways: Schema$TargetVpnGateway[]; /** @@ -9532,7 +9553,7 @@ export interface Schema$VpnTunnelList { } export interface Schema$VpnTunnelsScopedList { /** - * List of vpn tunnels contained in this scope. + * A list of vpn tunnels contained in this scope. */ vpnTunnels: Schema$VpnTunnel[]; /** @@ -23334,7 +23355,7 @@ export class Resource$Instancegroupmanagers { /** * compute.instanceGroupManagers.get * @desc Returns all of the details about the specified managed instance - * group. Get a list of available managed instance groups by making a list() + * group. Gets a list of available managed instance groups by making a list() * request. * @example * * // BEFORE RUNNING: @@ -29890,7 +29911,7 @@ export class Resource$Instancetemplates { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Get a list of available + * @desc Returns the specified instance template. Gets a list of available * instance templates by making a list() request. * @example * * // BEFORE RUNNING: @@ -32751,7 +32772,7 @@ export class Resource$Machinetypes { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Get a list of available machine + * @desc Returns the specified machine type. Gets a list of available machine * types by making a list() request. * @example * * // BEFORE RUNNING: @@ -34605,7 +34626,7 @@ export class Resource$Projects { /** * compute.projects.getXpnHost - * @desc Get the shared VPC host project that this project links to. May be + * @desc Gets the shared VPC host project that this project links to. May be * empty if no link exists. * @example * * // BEFORE RUNNING: @@ -34712,7 +34733,7 @@ export class Resource$Projects { /** * compute.projects.getXpnResources - * @desc Get service resources (a.k.a service project) associated with this + * @desc Gets service resources (a.k.a service project) associated with this * host project. * @example * * // BEFORE RUNNING: @@ -34838,7 +34859,7 @@ export class Resource$Projects { /** * compute.projects.listXpnHosts - * @desc List all shared VPC host projects visible to the user in an + * @desc Lists all shared VPC host projects visible to the user in an * organization. * @example * * // BEFORE RUNNING: @@ -45605,7 +45626,7 @@ export class Resource$Sslpolicies { /** * compute.sslPolicies.get - * @desc List all of the ordered rules present in a single specified policy. + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -45716,8 +45737,8 @@ export class Resource$Sslpolicies { /** * compute.sslPolicies.list - * @desc List 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. * @alias compute.sslPolicies.list * @memberOf! () * diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 9e3aaeeb8fd..6491618e119 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -296,7 +296,7 @@ export interface Schema$AcceleratorTypeList { } export interface Schema$AcceleratorTypesScopedList { /** - * [Output Only] List of accelerator types contained in this scope. + * [Output Only] A list of accelerator types contained in this scope. */ acceleratorTypes: Schema$AcceleratorType[]; /** @@ -456,7 +456,7 @@ export interface Schema$AddressAggregatedList { } export interface Schema$AddressesScopedList { /** - * [Output Only] List of addresses contained in this scope. + * [Output Only] A list of addresses contained in this scope. */ addresses: Schema$Address[]; /** @@ -818,7 +818,7 @@ export interface Schema$AutoscalerList { } export interface Schema$AutoscalersScopedList { /** - * [Output Only] List of autoscalers contained in this scope. + * [Output Only] A list of autoscalers contained in this scope. */ autoscalers: Schema$Autoscaler[]; /** @@ -1302,7 +1302,7 @@ export interface Schema$BackendServiceList { } export interface Schema$BackendServicesScopedList { /** - * List of BackendServices contained in this scope. + * A list of BackendServices contained in this scope. */ backendServices: Schema$BackendService[]; /** @@ -1410,7 +1410,7 @@ export interface Schema$Commitment { */ region: string; /** - * List of commitment amounts for particular resources. Note that VCPU and + * A list of commitment amounts for particular resources. Note that VCPU and * MEMORY resource commitments must occur together. */ resources: Schema$ResourceCommitment[]; @@ -1500,7 +1500,7 @@ export interface Schema$CommitmentList { } export interface Schema$CommitmentsScopedList { /** - * [Output Only] List of commitments contained in this scope. + * [Output Only] A list of commitments contained in this scope. */ commitments: Schema$Commitment[]; /** @@ -1839,7 +1839,7 @@ export interface Schema$DisksResizeRequest { } export interface Schema$DisksScopedList { /** - * [Output Only] List of disks contained in this scope. + * [Output Only] A list of disks contained in this scope. */ disks: Schema$Disk[]; /** @@ -1963,7 +1963,7 @@ export interface Schema$DiskTypeList { } export interface Schema$DiskTypesScopedList { /** - * [Output Only] List of disk types contained in this scope. + * [Output Only] A list of disk types contained in this scope. */ diskTypes: Schema$DiskType[]; /** @@ -2349,7 +2349,7 @@ export interface Schema$ForwardingRuleList { } export interface Schema$ForwardingRulesScopedList { /** - * List of forwarding rules contained in this scope. + * A list of forwarding rules contained in this scope. */ forwardingRules: Schema$ForwardingRule[]; /** @@ -3045,7 +3045,7 @@ export interface Schema$Instance { */ disks: Schema$AttachedDisk[]; /** - * List of the type and count of accelerator cards attached to the instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators: Schema$AcceleratorConfig[]; /** @@ -3239,8 +3239,8 @@ export interface Schema$InstanceGroup { */ network: string; /** - * The URL of the region where the instance group is located (for regional - * resources). + * [Output Only] The URL of the region where the instance group is located + * (for regional resources). */ region: string; /** @@ -3253,8 +3253,8 @@ export interface Schema$InstanceGroup { */ size: number; /** - * The URL of the subnetwork to which all instances in the instance group - * belong. + * [Output Only] The URL of the subnetwork to which all instances in the + * instance group belong. */ subnetwork: string; /** @@ -3846,7 +3846,7 @@ export interface Schema$InstanceReference { } export interface Schema$InstancesScopedList { /** - * [Output Only] List of instances contained in this scope. + * [Output Only] A list of instances contained in this scope. */ instances: Schema$Instance[]; /** @@ -3866,7 +3866,7 @@ export interface Schema$InstancesSetLabelsRequest { } export interface Schema$InstancesSetMachineResourcesRequest { /** - * List of the type and count of accelerator cards attached to the instance. + * A list of the type and count of accelerator cards attached to the instance. */ guestAccelerators: Schema$AcceleratorConfig[]; } @@ -4012,7 +4012,7 @@ export interface Schema$Interconnect { */ adminEnabled: boolean; /** - * [Output Only] List of CircuitInfo objects, that describe the individual + * [Output Only] A list of CircuitInfo objects, that describe the individual * circuits in this LAG. */ circuitInfos: Schema$InterconnectCircuitInfo[]; @@ -4031,7 +4031,7 @@ export interface Schema$Interconnect { */ description: string; /** - * [Output Only] List of outages expected for this Interconnect. + * [Output Only] A list of outages expected for this Interconnect. */ expectedOutages: Schema$InterconnectOutageNotification[]; /** @@ -4281,7 +4281,7 @@ export interface Schema$InterconnectAttachmentPrivateInfo { } export interface Schema$InterconnectAttachmentsScopedList { /** - * List of interconnect attachments contained in this scope. + * A list of interconnect attachments contained in this scope. */ interconnectAttachments: Schema$InterconnectAttachment[]; /** @@ -4711,7 +4711,7 @@ export interface Schema$MachineType { */ name: string; /** - * [Output Only] List of extended scratch disks assigned to the instance. + * [Output Only] A list of extended scratch disks assigned to the instance. */ scratchDisks: any[]; /** @@ -4791,7 +4791,7 @@ export interface Schema$MachineTypeList { } export interface Schema$MachineTypesScopedList { /** - * [Output Only] List of machine types contained in this scope. + * [Output Only] A list of machine types contained in this scope. */ machineTypes: Schema$MachineType[]; /** @@ -4945,7 +4945,7 @@ export interface Schema$Network { */ name: string; /** - * [Output Only] List of network peerings for the resource. + * [Output Only] A list of network peerings for the resource. */ peerings: Schema$NetworkPeering[]; /** @@ -5334,7 +5334,7 @@ export interface Schema$OperationList { } export interface Schema$OperationsScopedList { /** - * [Output Only] List of operations contained in this scope. + * [Output Only] A list of operations contained in this scope. */ operations: Schema$Operation[]; /** @@ -5696,7 +5696,7 @@ export interface Schema$RegionInstanceGroupManagersDeleteInstancesRequest { } export interface Schema$RegionInstanceGroupManagersListInstancesResponse { /** - * List of managed instances. + * A list of managed instances. */ managedInstances: Schema$ManagedInstance[]; } @@ -6239,7 +6239,7 @@ export interface Schema$RoutersPreviewResponse { } export interface Schema$RoutersScopedList { /** - * List of routers contained in this scope. + * A list of routers contained in this scope. */ routers: Schema$Router[]; /** @@ -6688,9 +6688,9 @@ export interface Schema$SslPolicy { */ creationTimestamp: string; /** - * List of features enabled when the selected profile is CUSTOM. The - method - * returns the set of features that can be specified in this list. This field - * must be empty if the profile is not CUSTOM. + * A list of features enabled when the selected profile is CUSTOM. The - + * method returns the set of features that can be specified in this list. This + * field must be empty if the profile is not CUSTOM. */ customFeatures: string[]; /** @@ -6722,7 +6722,7 @@ export interface Schema$SslPolicy { /** * The minimum version of SSL protocol that can be used by the clients to * establish a connection with the load balancer. This can be one of TLS_1_0, - * TLS_1_1, TLS_1_2, TLS_1_3. + * TLS_1_1, TLS_1_2. */ minTlsVersion: string; /** @@ -6936,7 +6936,7 @@ export interface Schema$SubnetworksExpandIpCidrRangeRequest { } export interface Schema$SubnetworksScopedList { /** - * List of subnetworks contained in this scope. + * A list of subnetworks contained in this scope. */ subnetworks: Schema$Subnetwork[]; /** @@ -7272,7 +7272,7 @@ export interface Schema$TargetInstanceList { } export interface Schema$TargetInstancesScopedList { /** - * List of target instances contained in this scope. + * A list of target instances contained in this scope. */ targetInstances: Schema$TargetInstance[]; /** @@ -7482,7 +7482,7 @@ export interface Schema$TargetPoolsRemoveInstanceRequest { } export interface Schema$TargetPoolsScopedList { /** - * List of target pools contained in this scope. + * A list of target pools contained in this scope. */ targetPools: Schema$TargetPool[]; /** @@ -7832,7 +7832,7 @@ export interface Schema$TargetVpnGatewayList { } export interface Schema$TargetVpnGatewaysScopedList { /** - * [Output Only] List of target vpn gateways contained in this scope. + * [Output Only] A list of target vpn gateways contained in this scope. */ targetVpnGateways: Schema$TargetVpnGateway[]; /** @@ -8216,7 +8216,7 @@ export interface Schema$VpnTunnelList { } export interface Schema$VpnTunnelsScopedList { /** - * List of vpn tunnels contained in this scope. + * A list of vpn tunnels contained in this scope. */ vpnTunnels: Schema$VpnTunnel[]; /** @@ -19745,7 +19745,7 @@ export class Resource$Instancegroupmanagers { /** * compute.instanceGroupManagers.get * @desc Returns all of the details about the specified managed instance - * group. Get a list of available managed instance groups by making a list() + * group. Gets a list of available managed instance groups by making a list() * request. * @example * * // BEFORE RUNNING: @@ -25145,7 +25145,7 @@ export class Resource$Instancetemplates { /** * compute.instanceTemplates.get - * @desc Returns the specified instance template. Get a list of available + * @desc Returns the specified instance template. Gets a list of available * instance templates by making a list() request. * @example * * // BEFORE RUNNING: @@ -27589,7 +27589,7 @@ export class Resource$Machinetypes { /** * compute.machineTypes.get - * @desc Returns the specified machine type. Get a list of available machine + * @desc Returns the specified machine type. Gets a list of available machine * types by making a list() request. * @example * * // BEFORE RUNNING: @@ -29322,7 +29322,7 @@ export class Resource$Projects { /** * compute.projects.getXpnHost - * @desc Get the shared VPC host project that this project links to. May be + * @desc Gets the shared VPC host project that this project links to. May be * empty if no link exists. * @example * * // BEFORE RUNNING: @@ -29429,7 +29429,7 @@ export class Resource$Projects { /** * compute.projects.getXpnResources - * @desc Get service resources (a.k.a service project) associated with this + * @desc Gets service resources (a.k.a service project) associated with this * host project. * @example * * // BEFORE RUNNING: @@ -29555,7 +29555,7 @@ export class Resource$Projects { /** * compute.projects.listXpnHosts - * @desc List all shared VPC host projects visible to the user in an + * @desc Lists all shared VPC host projects visible to the user in an * organization. * @example * * // BEFORE RUNNING: @@ -37340,7 +37340,7 @@ export class Resource$Sslpolicies { /** * compute.sslPolicies.get - * @desc List all of the ordered rules present in a single specified policy. + * @desc Lists all of the ordered rules present in a single specified policy. * @alias compute.sslPolicies.get * @memberOf! () * @@ -37450,8 +37450,8 @@ export class Resource$Sslpolicies { /** * compute.sslPolicies.list - * @desc List 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. * @alias compute.sslPolicies.list * @memberOf! () * diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 6c6d88b27a5..f4788f00c3b 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Kubernetes Engine API + * Kubernetes Engine API * * The Google Kubernetes Engine API is used for building and managing container * based applications, powered by the open source Kubernetes technology. @@ -1604,6 +1604,10 @@ export interface Schema$StartIPRotationRequest { * This field has been deprecated and replaced by the name field. */ projectId: string; + /** + * Whether to rotate credentials during IP rotation. + */ + rotateCredentials: boolean; /** * Deprecated. The name of the Google Compute Engine * [zone](/compute/docs/zones#available) in which the cluster resides. This diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 367872c7a53..19d5a3f38b8 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Kubernetes Engine API + * Kubernetes Engine API * * The Google Kubernetes Engine API is used for building and managing container * based applications, powered by the open source Kubernetes technology. @@ -330,6 +330,10 @@ export interface Schema$Cluster { * used. On output this shows the network ID instead of the name. */ network: string; + /** + * Configuration for cluster networking. + */ + networkConfig: Schema$NetworkConfig; /** * Configuration options for the NetworkPolicy feature. */ @@ -367,8 +371,8 @@ export interface Schema$Cluster { */ privateCluster: boolean; /** - * The resource labels for the cluster to use to annotate any related GCE - * resources. + * The resource labels for the cluster to use to annotate any related Google + * Compute Engine resources. */ resourceLabels: any; /** @@ -770,6 +774,23 @@ export interface Schema$ListOperationsResponse { */ operations: Schema$Operation[]; } +/** + * ListUsableSubnetworksResponse is the response of + * ListUsableSubnetworksRequest. + */ +export interface Schema$ListUsableSubnetworksResponse { + /** + * This token allows you to get the next page of results for list requests. If + * the number of results is larger than `page_size`, use the `next_page_token` + * as a value for the query parameter `page_token` in the next request. The + * value will become empty when there are no more pages. + */ + nextPageToken: string; + /** + * A list of usable subnetworks in the specified network project. + */ + subnetworks: Schema$UsableSubnetwork[]; +} /** * MaintenancePolicy defines the maintenance policy to be used for the cluster. */ @@ -845,6 +866,23 @@ export interface Schema$MasterAuthorizedNetworksConfig { */ enabled: boolean; } +/** + * NetworkConfig reports the relative names of network & subnetwork. + */ +export interface Schema$NetworkConfig { + /** + * Output only. The name of the Google Compute Engine + * network(/compute/docs/networks-and-firewalls#networks). Example: + * projects/my-project/global/networks/my-network + */ + network: string; + /** + * Output only. The name of the Google Compute Engine + * [subnetwork](/compute/docs/vpc). Example: + * projects/my-project/regions/us-central1/subnetworks/my-subnet + */ + subnetwork: string; +} /** * Configuration options for the NetworkPolicy feature. * https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ @@ -1668,6 +1706,10 @@ export interface Schema$StartIPRotationRequest { * This field has been deprecated and replaced by the name field. */ projectId: string; + /** + * Whether to rotate credentials during IP rotation. + */ + rotateCredentials: boolean; /** * Deprecated. The name of the Google Compute Engine * [zone](/compute/docs/zones#available) in which the cluster resides. This @@ -1791,6 +1833,25 @@ export interface Schema$UpdateNodePoolRequest { */ zone: string; } +/** + * UsableSubnetwork resource returns the subnetwork name, its associated network + * and the primary CIDR range. + */ +export interface Schema$UsableSubnetwork { + /** + * The range of internal addresses that are owned by this subnetwork. + */ + ipCidrRange: string; + /** + * Network Name. Example: projects/my-project/global/networks/my-network + */ + network: string; + /** + * Subnetwork Name. Example: + * projects/my-project/regions/us-central1/subnetworks/my-subnet + */ + subnetwork: string; +} /** * WorkloadMetadataConfig defines the metadata configuration to expose to * workloads on the node pool. @@ -1805,11 +1866,13 @@ export interface Schema$WorkloadMetadataConfig { export class Resource$Projects { root: Container; + aggregated: Resource$Projects$Aggregated; locations: Resource$Projects$Locations; zones: Resource$Projects$Zones; constructor(root: Container) { this.root = root; this.getRoot.bind(this); + this.aggregated = new Resource$Projects$Aggregated(root); this.locations = new Resource$Projects$Locations(root); this.zones = new Resource$Projects$Zones(root); } @@ -1818,6 +1881,94 @@ export class Resource$Projects { return this.root; } } +export class Resource$Projects$Aggregated { + root: Container; + usableSubnetworks: Resource$Projects$Aggregated$Usablesubnetworks; + constructor(root: Container) { + this.root = root; + this.getRoot.bind(this); + this.usableSubnetworks = + new Resource$Projects$Aggregated$Usablesubnetworks(root); + } + + getRoot() { + return this.root; + } +} +export class Resource$Projects$Aggregated$Usablesubnetworks { + root: Container; + constructor(root: Container) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * container.projects.aggregated.usableSubnetworks.list + * @desc Lists subnetworks that are usable for creating clusters in a project. + * @alias container.projects.aggregated.usableSubnetworks.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId` is the project which owns the listed subnetworks. This defaults to the parent project ID. + * @param {integer=} params.pageSize The max number of results per page that should be returned. If the number of available results is larger than `page_size`, a `next_page_token` is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.pageToken Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results. + * @param {string} params.parent The parent project where subnetworks are usable. Specified in the format 'projects/x'. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: any, options?: MethodOptions): + AxiosPromise; + list( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void; + list( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = options.rootUrl || 'https://container.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/aggregated/usableSubnetworks') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } +} + + export class Resource$Projects$Locations { root: Container; clusters: Resource$Projects$Locations$Clusters; diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 9ac5416a454..23113bec836 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -1849,16 +1849,34 @@ export interface Schema$OrderCustomer { */ email: string; /** - * If set, this indicates the user explicitly chose to opt in or out of - * providing marketing rights to the merchant. If unset, this indicates the - * user has already made this choice in a previous purchase, and was thus not - * shown the marketing right opt in/out checkbox during the checkout flow. + * Deprecated. Please use marketingRightsInfo instead. */ explicitMarketingPreference: boolean; /** * Full name of the customer. */ fullName: string; + /** + * Customer's marketing preferences. + */ + marketingRightsInfo: Schema$OrderCustomerMarketingRightsInfo; +} +export interface Schema$OrderCustomerMarketingRightsInfo { + /** + * Last known user selection regarding marketing preferences. In certain cases + * this selection might not be known, so this field would be empty. + */ + explicitMarketingPreference: string; + /** + * Timestamp when last time marketing preference was updated. Could be empty, + * if user wasn't offered a selection yet. + */ + lastUpdatedTimestamp: string; + /** + * Email address that can be used for marketing purposes. This field is only + * filled when explicitMarketingPreference is equal to 'granted'. + */ + marketingEmailAddress: string; } export interface Schema$OrderDeliveryDetails { /** @@ -4283,10 +4301,22 @@ export interface Schema$ProductStatusItemLevelIssue { * The error code of the issue. */ code: string; + /** + * A short issue description in English. + */ + description: string; /** * The destination the issue applies to. */ destination: string; + /** + * A detailed issue description in English. + */ + detail: string; + /** + * The URL of a web page to help with resolving this issue. + */ + documentation: string; /** * Whether the issue can be resolved by the merchant. */ @@ -4404,6 +4434,10 @@ export interface Schema$Service { * Required. */ deliveryTime: Schema$DeliveryTime; + /** + * Eligibility for this service. + */ + eligibility: string; /** * Minimum order value for this service. If set, indicates that customers will * have to spend at least this amount. All prices within a service must have @@ -4607,17 +4641,29 @@ export interface Schema$TestOrderCustomer { */ email: string; /** - * If set, this indicates the user explicitly chose to opt in or out of - * providing marketing rights to the merchant. If unset, this indicates the - * user has already made this choice in a previous purchase, and was thus not - * shown the marketing right opt in/out checkbox during the checkout flow. - * Optional. + * Deprecated. Please use marketingRightsInfo instead. */ explicitMarketingPreference: boolean; /** * Full name of the customer. */ fullName: string; + /** + * Customer's marketing preferences. + */ + marketingRightsInfo: Schema$TestOrderCustomerMarketingRightsInfo; +} +export interface Schema$TestOrderCustomerMarketingRightsInfo { + /** + * Last know user use selection regards marketing preferences. In certain + * cases selection might not be known, so this field would be empty. + */ + explicitMarketingPreference: string; + /** + * Timestamp when last time marketing preference was updated. Could be empty, + * if user wasn't offered a selection yet. + */ + lastUpdatedTimestamp: string; } export interface Schema$TestOrderLineItem { /** diff --git a/src/apis/content/v2sandbox.ts b/src/apis/content/v2sandbox.ts index dbabfcfdc73..b79eaf9f6b0 100644 --- a/src/apis/content/v2sandbox.ts +++ b/src/apis/content/v2sandbox.ts @@ -250,16 +250,34 @@ export interface Schema$OrderCustomer { */ email: string; /** - * If set, this indicates the user explicitly chose to opt in or out of - * providing marketing rights to the merchant. If unset, this indicates the - * user has already made this choice in a previous purchase, and was thus not - * shown the marketing right opt in/out checkbox during the checkout flow. + * Deprecated. Please use marketingRightsInfo instead. */ explicitMarketingPreference: boolean; /** * Full name of the customer. */ fullName: string; + /** + * Customer's marketing preferences. + */ + marketingRightsInfo: Schema$OrderCustomerMarketingRightsInfo; +} +export interface Schema$OrderCustomerMarketingRightsInfo { + /** + * Last known user selection regarding marketing preferences. In certain cases + * this selection might not be known, so this field would be empty. + */ + explicitMarketingPreference: string; + /** + * Timestamp when last time marketing preference was updated. Could be empty, + * if user wasn't offered a selection yet. + */ + lastUpdatedTimestamp: string; + /** + * Email address that can be used for marketing purposes. This field is only + * filled when explicitMarketingPreference is equal to 'granted'. + */ + marketingEmailAddress: string; } export interface Schema$OrderDeliveryDetails { /** @@ -1650,17 +1668,29 @@ export interface Schema$TestOrderCustomer { */ email: string; /** - * If set, this indicates the user explicitly chose to opt in or out of - * providing marketing rights to the merchant. If unset, this indicates the - * user has already made this choice in a previous purchase, and was thus not - * shown the marketing right opt in/out checkbox during the checkout flow. - * Optional. + * Deprecated. Please use marketingRightsInfo instead. */ explicitMarketingPreference: boolean; /** * Full name of the customer. */ fullName: string; + /** + * Customer's marketing preferences. + */ + marketingRightsInfo: Schema$TestOrderCustomerMarketingRightsInfo; +} +export interface Schema$TestOrderCustomerMarketingRightsInfo { + /** + * Last know user use selection regards marketing preferences. In certain + * cases selection might not be known, so this field would be empty. + */ + explicitMarketingPreference: string; + /** + * Timestamp when last time marketing preference was updated. Could be empty, + * if user wasn't offered a selection yet. + */ + lastUpdatedTimestamp: string; } export interface Schema$TestOrderLineItem { /** diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index fe0128f9902..213ecb9c6f1 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -167,6 +167,11 @@ export interface Schema$AutoscalingEvent { * num_workers value. */ time: string; + /** + * A short and friendly name for the worker pool this event refers to, + * populated from the value of PoolStageRelation::user_pool_name. + */ + workerPool: string; } /** * Settings for WorkerPool autoscaling. @@ -1355,6 +1360,12 @@ export interface Schema$MetricUpdate { * A struct value describing properties of a distribution of numeric values. */ distribution: any; + /** + * A struct value describing properties of a Gauge. Metrics of gauge type show + * the value of a metric across time, and is aggregated based on the newest + * value. + */ + gauge: any; /** * Worker-computed aggregate value for internal use by the Dataflow service. */ diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index fb1f5291c0f..96a400db835 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Dataproc API + * Cloud Dataproc API * * Manages Hadoop-based clusters and jobs on Google Cloud Platform. * @@ -919,9 +919,10 @@ export interface Schema$QueryList { */ export interface Schema$SoftwareConfig { /** - * Optional. The version of software inside the cluster. It must match the - * regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the - * latest version (see Cloud Dataproc Versioning). + * Optional. The version of software inside the cluster. It must be one of the + * supported Cloud Dataproc Versions, such as "1.2" (including a + * subminor version, such as "1.2.29"), or the "preview" + * version. If unspecified, it defaults to the latest version. */ imageVersion: string; /** diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index d36b36c70a3..8579a9d85c7 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Dataproc API + * Cloud Dataproc API * * Manages Hadoop-based clusters and jobs on Google Cloud Platform. * @@ -1064,17 +1064,21 @@ export interface Schema$PigJob { /** * 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 + * 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.Example { + * 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", ] + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] * }, { "role": "roles/viewer", - * "members": ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the IAM developer's guide + * "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 { @@ -1179,9 +1183,10 @@ export interface Schema$SetIamPolicyRequest { */ export interface Schema$SoftwareConfig { /** - * Optional. The version of software inside the cluster. It must match the - * regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the - * latest version (see Cloud Dataproc Versioning). + * Optional. The version of software inside the cluster. It must be one of the + * supported Cloud Dataproc Versions, such as "1.2" (including a + * subminor version, such as "1.2.29"), or the "preview" + * version. If unspecified, it defaults to the latest version. */ imageVersion: string; /** diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index 5d486f82518..76f14f3aa87 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Datastore API + * Cloud Datastore API * * Accesses the schemaless NoSQL database to provide fully managed, robust, * scalable storage for your application. diff --git a/src/apis/datastore/v1beta1.ts b/src/apis/datastore/v1beta1.ts index 210433758e7..ec39ce91deb 100644 --- a/src/apis/datastore/v1beta1.ts +++ b/src/apis/datastore/v1beta1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Datastore API + * Cloud Datastore API * * Accesses the schemaless NoSQL database to provide fully managed, robust, * scalable storage for your application. diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index a4f303f83ac..750c2b54c52 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Datastore API + * Cloud Datastore API * * Accesses the schemaless NoSQL database to provide fully managed, robust, * scalable storage for your application. diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index aec1b188c92..cc6665648a6 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -571,7 +571,9 @@ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessage { */ listSelect: Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelect; /** - * Returns a response containing a custom payload. + * Returns a response containing a custom, platform-specific payload. See the + * Intent.Message.Platform type for a description of the structure that may be + * required for your platform. */ payload: any; /** @@ -955,6 +957,15 @@ export interface Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart { */ userDefined: boolean; } +/** + * Metadata in google::longrunning::Operation for Knowledge operations. + */ +export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata { + /** + * Required. The current state of this operation. + */ + state: string; +} /** * Represents the contents of the original request that was passed to the * `[Streaming]DetectIntent` call. @@ -967,8 +978,7 @@ export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest payload: any; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is set - * by Dialogflow-owned servers. Possible values of this field correspond to - * Intent.Message.Platform. + * by Dialogflow-owned servers. */ source: string; } @@ -1112,6 +1122,16 @@ export interface Schema$GoogleCloudDialogflowV2beta1WebhookResponse { outputContexts: Schema$GoogleCloudDialogflowV2beta1Context[]; /** * Optional. This value is passed directly to `QueryResult.webhook_payload`. + * See the related `fulfillment_messages[i].payload field`, which may be used + * as an alternative to this field. This field can be used for Actions on + * Google responses. It should have a structure similar to the JSON message + * shown here. For more information, see [Actions on Google Webhook + * Format](https://developers.google.com/actions/dialogflow/webhook) + * <pre>{ "google": { "expectUserResponse": + * true, "richResponse": { "items": [ { + * "simpleResponse": { "textToSpeech": + * "this is a simple response" } } ] } + * } }</pre> */ payload: any; /** @@ -1499,7 +1519,9 @@ export interface Schema$GoogleCloudDialogflowV2IntentMessage { */ listSelect: Schema$GoogleCloudDialogflowV2IntentMessageListSelect; /** - * The response containing a custom payload. + * Returns a response containing a custom, platform-specific payload. See the + * Intent.Message.Platform type for a description of the structure that may be + * required for your platform. */ payload: any; /** @@ -1953,8 +1975,7 @@ export interface Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest { payload: any; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is set - * by Dialogflow-owned servers. Possible values of this field correspond to - * Intent.Message.Platform. + * by Dialogflow-owned servers. */ source: string; } @@ -2236,6 +2257,16 @@ export interface Schema$GoogleCloudDialogflowV2WebhookResponse { outputContexts: Schema$GoogleCloudDialogflowV2Context[]; /** * Optional. This value is passed directly to `QueryResult.webhook_payload`. + * See the related `fulfillment_messages[i].payload field`, which may be used + * as an alternative to this field. This field can be used for Actions on + * Google responses. It should have a structure similar to the JSON message + * shown here. For more information, see [Actions on Google Webhook + * Format](https://developers.google.com/actions/dialogflow/webhook) + * <pre>{ "google": { "expectUserResponse": + * true, "richResponse": { "items": [ { + * "simpleResponse": { "textToSpeech": + * "this is a simple response" } } ] } + * } }</pre> */ payload: any; /** diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 3ee420af803..56ce7a9029b 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -690,7 +690,9 @@ export interface Schema$GoogleCloudDialogflowV2beta1IntentMessage { */ listSelect: Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelect; /** - * Returns a response containing a custom payload. + * Returns a response containing a custom, platform-specific payload. See the + * Intent.Message.Platform type for a description of the structure that may be + * required for your platform. */ payload: any; /** @@ -1074,6 +1076,15 @@ export interface Schema$GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart { */ userDefined: boolean; } +/** + * Metadata in google::longrunning::Operation for Knowledge operations. + */ +export interface Schema$GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata { + /** + * Required. The current state of this operation. + */ + state: string; +} /** * The response message for Contexts.ListContexts. */ @@ -1146,8 +1157,7 @@ export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest payload: any; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is set - * by Dialogflow-owned servers. Possible values of this field correspond to - * Intent.Message.Platform. + * by Dialogflow-owned servers. */ source: string; } @@ -1436,6 +1446,16 @@ export interface Schema$GoogleCloudDialogflowV2beta1WebhookResponse { outputContexts: Schema$GoogleCloudDialogflowV2beta1Context[]; /** * Optional. This value is passed directly to `QueryResult.webhook_payload`. + * See the related `fulfillment_messages[i].payload field`, which may be used + * as an alternative to this field. This field can be used for Actions on + * Google responses. It should have a structure similar to the JSON message + * shown here. For more information, see [Actions on Google Webhook + * Format](https://developers.google.com/actions/dialogflow/webhook) + * <pre>{ "google": { "expectUserResponse": + * true, "richResponse": { "items": [ { + * "simpleResponse": { "textToSpeech": + * "this is a simple response" } } ] } + * } }</pre> */ payload: any; /** @@ -1704,7 +1724,9 @@ export interface Schema$GoogleCloudDialogflowV2IntentMessage { */ listSelect: Schema$GoogleCloudDialogflowV2IntentMessageListSelect; /** - * The response containing a custom payload. + * Returns a response containing a custom, platform-specific payload. See the + * Intent.Message.Platform type for a description of the structure that may be + * required for your platform. */ payload: any; /** @@ -2098,8 +2120,7 @@ export interface Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest { payload: any; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is set - * by Dialogflow-owned servers. Possible values of this field correspond to - * Intent.Message.Platform. + * by Dialogflow-owned servers. */ source: string; } @@ -2243,6 +2264,16 @@ export interface Schema$GoogleCloudDialogflowV2WebhookResponse { outputContexts: Schema$GoogleCloudDialogflowV2Context[]; /** * Optional. This value is passed directly to `QueryResult.webhook_payload`. + * See the related `fulfillment_messages[i].payload field`, which may be used + * as an alternative to this field. This field can be used for Actions on + * Google responses. It should have a structure similar to the JSON message + * shown here. For more information, see [Actions on Google Webhook + * Format](https://developers.google.com/actions/dialogflow/webhook) + * <pre>{ "google": { "expectUserResponse": + * true, "richResponse": { "items": [ { + * "simpleResponse": { "textToSpeech": + * "this is a simple response" } } ] } + * } }</pre> */ payload: any; /** diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 9090445f6f5..35a9c011bb0 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -942,6 +942,12 @@ export interface Schema$GooglePrivacyDlpV2BigQueryOptions { * fields in the format, like `person.birthdate.year`, are allowed. */ identifyingFields: Schema$GooglePrivacyDlpV2FieldId[]; + /** + * Max number of rows to scan. If the table has more rows than this value, the + * rest of the rows are omitted. If not set, or if set to 0, all rows will be + * scanned. Cannot be used in conjunction with TimespanConfig. + */ + rowsLimit: string; /** * Complete BigQuery table reference. */ @@ -2689,7 +2695,7 @@ export interface Schema$GooglePrivacyDlpV2Proximity { } /** * Publish the results of a DlpJob to a pub sub channel. Compatible with: - * Inpect, Risk + * Inspect, Risk */ export interface Schema$GooglePrivacyDlpV2PublishToPubSub { /** @@ -2904,8 +2910,8 @@ export interface Schema$GooglePrivacyDlpV2ReplaceWithInfoTypeConfig {} export interface Schema$GooglePrivacyDlpV2RequestedOptions { jobConfig: Schema$GooglePrivacyDlpV2InspectJobConfig; /** - * If run with an inspect template, a snapshot of it's state at the time - * of this run. + * If run with an InspectTemplate, a snapshot of its state at the time of this + * run. */ snapshotInspectTemplate: Schema$GooglePrivacyDlpV2InspectTemplate; } @@ -2947,7 +2953,8 @@ export interface Schema$GooglePrivacyDlpV2Row { } /** * If set, the detailed findings will be persisted to the specified - * OutputStorageConfig. Compatible with: Inspect + * OutputStorageConfig. Only a single instance of this action can be specified. + * Compatible with: Inspect */ export interface Schema$GooglePrivacyDlpV2SaveFindings { outputConfig: Schema$GooglePrivacyDlpV2OutputStorageConfig; @@ -3471,8 +3478,8 @@ export class Resource$Organizations$Deidentifytemplates { /** * dlp.organizations.deidentifyTemplates.create - * @desc Creates a de-identify template for re-using frequently used - * configuration for Deidentifying content, images, and storage. + * @desc Creates a DeidentifyTemplate for re-using frequently used + * configuration for de-identifying content, images, and storage. * @alias dlp.organizations.deidentifyTemplates.create * @memberOf! () * @@ -3534,7 +3541,7 @@ export class Resource$Organizations$Deidentifytemplates { /** * dlp.organizations.deidentifyTemplates.delete - * @desc Deletes a de-identify template. + * @desc Deletes a DeidentifyTemplate. * @alias dlp.organizations.deidentifyTemplates.delete * @memberOf! () * @@ -3587,7 +3594,7 @@ export class Resource$Organizations$Deidentifytemplates { /** * dlp.organizations.deidentifyTemplates.get - * @desc Gets a de-identify template. + * @desc Gets a DeidentifyTemplate. * @alias dlp.organizations.deidentifyTemplates.get * @memberOf! () * @@ -3645,7 +3652,7 @@ export class Resource$Organizations$Deidentifytemplates { /** * dlp.organizations.deidentifyTemplates.list - * @desc Lists de-identify templates. + * @desc Lists DeidentifyTemplates. * @alias dlp.organizations.deidentifyTemplates.list * @memberOf! () * @@ -3708,7 +3715,7 @@ export class Resource$Organizations$Deidentifytemplates { /** * dlp.organizations.deidentifyTemplates.patch - * @desc Updates the de-identify template. + * @desc Updates the DeidentifyTemplate. * @alias dlp.organizations.deidentifyTemplates.patch * @memberOf! () * @@ -3781,8 +3788,8 @@ export class Resource$Organizations$Inspecttemplates { /** * dlp.organizations.inspectTemplates.create - * @desc Creates an inspect template for re-using frequently used - * configuration for inspecting content, images, and storage. + * @desc Creates an InspectTemplate for re-using frequently used configuration + * for inspecting content, images, and storage. * @alias dlp.organizations.inspectTemplates.create * @memberOf! () * @@ -3843,7 +3850,7 @@ export class Resource$Organizations$Inspecttemplates { /** * dlp.organizations.inspectTemplates.delete - * @desc Deletes an inspect template. + * @desc Deletes an InspectTemplate. * @alias dlp.organizations.inspectTemplates.delete * @memberOf! () * @@ -3896,7 +3903,7 @@ export class Resource$Organizations$Inspecttemplates { /** * dlp.organizations.inspectTemplates.get - * @desc Gets an inspect template. + * @desc Gets an InspectTemplate. * @alias dlp.organizations.inspectTemplates.get * @memberOf! () * @@ -3953,7 +3960,7 @@ export class Resource$Organizations$Inspecttemplates { /** * dlp.organizations.inspectTemplates.list - * @desc Lists inspect templates. + * @desc Lists InspectTemplates. * @alias dlp.organizations.inspectTemplates.list * @memberOf! () * @@ -4015,7 +4022,7 @@ export class Resource$Organizations$Inspecttemplates { /** * dlp.organizations.inspectTemplates.patch - * @desc Updates the inspect template. + * @desc Updates the InspectTemplate. * @alias dlp.organizations.inspectTemplates.patch * @memberOf! () * @@ -4311,8 +4318,8 @@ export class Resource$Projects$Deidentifytemplates { /** * dlp.projects.deidentifyTemplates.create - * @desc Creates a de-identify template for re-using frequently used - * configuration for Deidentifying content, images, and storage. + * @desc Creates a DeidentifyTemplate for re-using frequently used + * configuration for de-identifying content, images, and storage. * @alias dlp.projects.deidentifyTemplates.create * @memberOf! () * @@ -4374,7 +4381,7 @@ export class Resource$Projects$Deidentifytemplates { /** * dlp.projects.deidentifyTemplates.delete - * @desc Deletes a de-identify template. + * @desc Deletes a DeidentifyTemplate. * @alias dlp.projects.deidentifyTemplates.delete * @memberOf! () * @@ -4427,7 +4434,7 @@ export class Resource$Projects$Deidentifytemplates { /** * dlp.projects.deidentifyTemplates.get - * @desc Gets a de-identify template. + * @desc Gets a DeidentifyTemplate. * @alias dlp.projects.deidentifyTemplates.get * @memberOf! () * @@ -4485,7 +4492,7 @@ export class Resource$Projects$Deidentifytemplates { /** * dlp.projects.deidentifyTemplates.list - * @desc Lists de-identify templates. + * @desc Lists DeidentifyTemplates. * @alias dlp.projects.deidentifyTemplates.list * @memberOf! () * @@ -4548,7 +4555,7 @@ export class Resource$Projects$Deidentifytemplates { /** * dlp.projects.deidentifyTemplates.patch - * @desc Updates the de-identify template. + * @desc Updates the DeidentifyTemplate. * @alias dlp.projects.deidentifyTemplates.patch * @memberOf! () * @@ -4676,7 +4683,7 @@ export class Resource$Projects$Dlpjobs { /** * dlp.projects.dlpJobs.create - * @desc Creates a new job to inspect storage or calculate risk metrics + * @desc Creates a new job to inspect storage or calculate risk metrics. * [How-to guide](/dlp/docs/compute-risk-analysis). * @alias dlp.projects.dlpJobs.create * @memberOf! () @@ -4995,8 +5002,8 @@ export class Resource$Projects$Inspecttemplates { /** * dlp.projects.inspectTemplates.create - * @desc Creates an inspect template for re-using frequently used - * configuration for inspecting content, images, and storage. + * @desc Creates an InspectTemplate for re-using frequently used configuration + * for inspecting content, images, and storage. * @alias dlp.projects.inspectTemplates.create * @memberOf! () * @@ -5057,7 +5064,7 @@ export class Resource$Projects$Inspecttemplates { /** * dlp.projects.inspectTemplates.delete - * @desc Deletes an inspect template. + * @desc Deletes an InspectTemplate. * @alias dlp.projects.inspectTemplates.delete * @memberOf! () * @@ -5110,7 +5117,7 @@ export class Resource$Projects$Inspecttemplates { /** * dlp.projects.inspectTemplates.get - * @desc Gets an inspect template. + * @desc Gets an InspectTemplate. * @alias dlp.projects.inspectTemplates.get * @memberOf! () * @@ -5167,7 +5174,7 @@ export class Resource$Projects$Inspecttemplates { /** * dlp.projects.inspectTemplates.list - * @desc Lists inspect templates. + * @desc Lists InspectTemplates. * @alias dlp.projects.inspectTemplates.list * @memberOf! () * @@ -5229,7 +5236,7 @@ export class Resource$Projects$Inspecttemplates { /** * dlp.projects.inspectTemplates.patch - * @desc Updates the inspect template. + * @desc Updates the InspectTemplate. * @alias dlp.projects.inspectTemplates.patch * @memberOf! () * diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index eb2ec85c703..a3b413397ba 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -485,6 +485,10 @@ export interface Schema$Project { * Limits associated with a Project. */ export interface Schema$Quota { + /** + * Whether a black hole zone should suppress system zones for this project. + */ + blackHoleHidesSystemZones: boolean; /** * Maximum allowed number of DnsKeys per ManagedZone. */ diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 312f5ddba86..4d002b4460b 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -485,6 +485,10 @@ export interface Schema$Project { * Limits associated with a Project. */ export interface Schema$Quota { + /** + * Whether a black hole zone should suppress system zones for this project. + */ + blackHoleHidesSystemZones: boolean; /** * Maximum allowed number of DnsKeys per ManagedZone. */ @@ -1271,7 +1275,7 @@ export class Resource$Managedzones { /** * dns.managedZones.patch - * @desc Update an existing ManagedZone. This method supports patch semantics. + * @desc Apply a partial update to an existing ManagedZone. * @alias dns.managedZones.patch * @memberOf! () * diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index b5d7eea6140..40057d59c3a 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -485,6 +485,10 @@ export interface Schema$Project { * Limits associated with a Project. */ export interface Schema$Quota { + /** + * Whether a black hole zone should suppress system zones for this project. + */ + blackHoleHidesSystemZones: boolean; /** * Maximum allowed number of DnsKeys per ManagedZone. */ diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 5574c05db6e..e19f30918f9 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Firestore API + * Cloud Firestore API * * * @@ -981,7 +981,8 @@ export interface Schema$UnaryFilter { */ export interface Schema$Value { /** - * An array value. Cannot contain another array value. + * An array value. Cannot directly contain another array value, though can + * contain an map which contains another array. */ arrayValue: Schema$ArrayValue; /** diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 765918038ae..ccc12da9a61 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Identity and Access Management (IAM) API + * Identity and Access Management (IAM) API * * Manages identity and access control for Google Cloud Platform resources, * including the creation of service accounts, which you can use to authenticate @@ -108,7 +108,7 @@ export interface Schema$AuditableService { */ export interface Schema$AuditConfig { /** - * The configuration for logging of each type of permission. Next ID: 4 + * The configuration for logging of each type of permission. */ auditLogConfigs: Schema$AuditLogConfig[]; /** diff --git a/src/apis/index.ts b/src/apis/index.ts index d548c48cfa4..f87e7925b14 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -203,7 +203,9 @@ import * as tpu_v1alpha1 from './tpu/v1alpha1'; import * as translate_v2 from './translate/v2'; import * as urlshortener_v1 from './urlshortener/v1'; import * as vault_v1 from './vault/v1'; +import * as videointelligence_v1 from './videointelligence/v1'; import * as videointelligence_v1beta1 from './videointelligence/v1beta1'; +import * as videointelligence_v1beta2 from './videointelligence/v1beta2'; import * as vision_v1 from './vision/v1'; import * as vision_v1p1beta1 from './vision/v1p1beta1'; import * as vision_v1p2beta1 from './vision/v1p2beta1'; @@ -212,6 +214,7 @@ import * as webmasters_v3 from './webmasters/v3'; import * as youtube_v3 from './youtube/v3'; import * as youtubeAnalytics_v1 from './youtubeAnalytics/v1'; import * as youtubeAnalytics_v1beta1 from './youtubeAnalytics/v1beta1'; +import * as youtubeAnalytics_v2 from './youtubeAnalytics/v2'; import * as youtubereporting_v1 from './youtubereporting/v1'; export interface APIList { @@ -652,7 +655,9 @@ export const APIS: APIList = { 'v1': vault_v1.Vault, }, videointelligence: { + 'v1': videointelligence_v1.Videointelligence, 'v1beta1': videointelligence_v1beta1.Videointelligence, + 'v1beta2': videointelligence_v1beta2.Videointelligence, }, vision: { 'v1': vision_v1.Vision, @@ -671,6 +676,7 @@ export const APIS: APIList = { youtubeAnalytics: { 'v1': youtubeAnalytics_v1.Youtubeanalytics, 'v1beta1': youtubeAnalytics_v1beta1.Youtubeanalytics, + 'v2': youtubeAnalytics_v2.Youtubeanalytics, }, youtubereporting: { 'v1': youtubereporting_v1.Youtubereporting, @@ -1196,8 +1202,11 @@ export class GeneratedAPIs { vault(options: ServiceOptions|string) { return this.getAPI('vault', options); } - videointelligence( - options: ServiceOptions|string) { + videointelligence< + T = videointelligence_v1.Videointelligence | + videointelligence_v1beta1.Videointelligence | + videointelligence_v1beta2.Videointelligence>(options: ServiceOptions| + string) { return this.getAPI('videointelligence', options); } vision< @@ -1216,8 +1225,9 @@ export class GeneratedAPIs { } youtubeAnalytics< T = youtubeAnalytics_v1.Youtubeanalytics | - youtubeAnalytics_v1beta1.Youtubeanalytics>(options: ServiceOptions| - string) { + youtubeAnalytics_v1beta1.Youtubeanalytics | + youtubeAnalytics_v2.Youtubeanalytics>(options: ServiceOptions| + string) { return this.getAPI('youtubeAnalytics', options); } youtubereporting(options: diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index b4475d1ff60..fc0d9d711e3 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -2049,10 +2049,12 @@ export class Resource$Entries { /** * logging.entries.write - * @desc Log entry resourcesWrites log entries to Stackdriver Logging. This - * API method is the only way to send log entries to Stackdriver Logging. This - * method is used, directly or indirectly, by the Stackdriver Logging agent - * (fluentd) and all logging libraries configured to use Stackdriver Logging. + * @desc Writes log entries to Stackdriver Logging. This API method is the + * only way to send log entries to Stackdriver Logging. This method is used, + * directly or indirectly, by the Stackdriver Logging agent (fluentd) and all + * logging libraries configured to use Stackdriver Logging. A single request + * may contain log entries for a maximum of 1000 different resources + * (projects, organizations, billing accounts or folders) * @alias logging.entries.write * @memberOf! () * diff --git a/src/apis/logging/v2beta1.ts b/src/apis/logging/v2beta1.ts index d49a674d035..bc21fe2e9b3 100644 --- a/src/apis/logging/v2beta1.ts +++ b/src/apis/logging/v2beta1.ts @@ -1560,10 +1560,12 @@ export class Resource$Entries { /** * logging.entries.write - * @desc Log entry resourcesWrites log entries to Stackdriver Logging. This - * API method is the only way to send log entries to Stackdriver Logging. This - * method is used, directly or indirectly, by the Stackdriver Logging agent - * (fluentd) and all logging libraries configured to use Stackdriver Logging. + * @desc Writes log entries to Stackdriver Logging. This API method is the + * only way to send log entries to Stackdriver Logging. This method is used, + * directly or indirectly, by the Stackdriver Logging agent (fluentd) and all + * logging libraries configured to use Stackdriver Logging. A single request + * may contain log entries for a maximum of 1000 different resources + * (projects, organizations, billing accounts or folders) * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 70504fbf0c1..12a0502c9e4 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -120,17 +120,16 @@ export interface Schema$GoogleCloudMlV1__AutoScaling { * nodes are always up, starting from the time the model is deployed, so 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 - * [pricing](https://cloud.google.com/ml-engine/pricing#prediction_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. + * 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. */ minNodes: number; } @@ -199,6 +198,12 @@ export interface Schema$GoogleCloudMlV1__HyperparameterOutput { * Represents a set of hyperparameters to optimize. */ export interface Schema$GoogleCloudMlV1__HyperparameterSpec { + /** + * Optional. The search algorithm specified for the hyperparameter tuning job. + * Uses the default CloudML Engine hyperparameter tuning algorithm if + * unspecified. + */ + algorithm: string; /** * Optional. Indicates if the hyperparameter tuning job enables auto trial * early stopping. @@ -391,12 +396,12 @@ export interface Schema$GoogleCloudMlV1__Model { * Optional. The list of regions where the model is going to be deployed. * Currently only one region per model is supported. Defaults to * 'us-central1' if nothing is set. See the <a - * href="/ml-engine/docs/regions">available regions</a> for - * ML Engine services. Note: * No matter where a model is deployed, it can - * always be accessed by users from anywhere, both for online and batch - * prediction. * The region for a batch prediction job is set by the region - * field when submitting the batch prediction job and does not take its - * value from this field. + * href="/ml-engine/docs/tensorflow/regions">available + * regions</a> for ML Engine services. Note: * No matter where a model + * is deployed, it can always be accessed by users from anywhere, both for + * online and batch prediction. * The region for a batch prediction job is + * set by the region field when submitting the batch prediction job and + * does not take its value from this field. */ regions: string[]; } @@ -506,7 +511,7 @@ export interface Schema$GoogleCloudMlV1__PredictionInput { /** * Use this field if you want to use the default version for the specified * model. The string must use the following format: - * `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"` + * `"projects/YOUR_PROJECT/models/YOUR_MODEL"` */ modelName: string; /** @@ -515,7 +520,8 @@ export interface Schema$GoogleCloudMlV1__PredictionInput { outputPath: string; /** * Required. The Google Compute Engine region to run the prediction job in. - * See the <a href="/ml-engine/docs/regions">available + * See the <a + * href="/ml-engine/docs/tensorflow/regions">available * regions</a> for ML Engine services. */ region: string; @@ -545,7 +551,7 @@ export interface Schema$GoogleCloudMlV1__PredictionInput { * Use this field if you want to specify a version of the model to use. The * string is formatted the same way as `model_version`, with the addition of * the version information: - * `"projects/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"` + * `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"` */ versionName: string; } @@ -588,8 +594,8 @@ export interface Schema$GoogleCloudMlV1__SetDefaultVersionRequest {} * to submit your training job, you can specify the input parameters as * command-line arguments and/or in a YAML configuration file referenced from * the --config command-line argument. For details, see the guide to <a - * href="/ml-engine/docs/training-jobs">submitting a training - * job</a>. Next ID: 22 + * href="/ml-engine/docs/tensorflow/training-jobs">submitting a + * training job</a>. */ export interface Schema$GoogleCloudMlV1__TrainingInput { /** @@ -630,8 +636,8 @@ export interface Schema$GoogleCloudMlV1__TrainingInput { * equivalent to <code * suppresswarning="true">standard</code> that also * includes a single NVIDIA Tesla K80 GPU. See more about <a - * href="/ml-engine/docs/how-tos/using-gpus"> using GPUs for - * training your model</a>. </dd> + * href="/ml-engine/docs/tensorflow/using-gpus">using GPUs to + * train your model</a>. </dd> * <dt>complex_model_m_gpu</dt> <dd> A machine * equivalent to <code * suppresswarning="true">complex_model_m</code> that also @@ -648,7 +654,11 @@ export interface Schema$GoogleCloudMlV1__TrainingInput { * equivalent to <code * suppresswarning="true">complex_model_m</code> that also * includes four NVIDIA Tesla P100 GPUs. The availability of these GPUs is - * in the Beta launch stage. </dd> </dl> You must set this + * in the Beta launch stage. </dd> <dt>standard_tpu</dt> + * <dd> A TPU VM including one Cloud TPU. The availability of Cloud + * TPU is in <i>Beta</i> launch stage. See more about <a + * href="/ml-engine/docs/tensorflow/using-tpus">using TPUs to + * train your model</a>. </dd> </dl> You must set this * value when `scaleTier` is set to `CUSTOM`. */ masterType: string; @@ -687,7 +697,7 @@ export interface Schema$GoogleCloudMlV1__TrainingInput { pythonVersion: string; /** * Required. The Google Compute Engine region to run the training job in. See - * the <a href="/ml-engine/docs/regions">available + * the <a href="/ml-engine/docs/tensorflow/regions">available * regions</a> for ML Engine services. */ region: string; @@ -760,8 +770,8 @@ export interface Schema$GoogleCloudMlV1__Version { createTime: string; /** * Required. The Google Cloud Storage location of the trained model used to - * create the version. See the [overview of model - * deployment](/ml-engine/docs/concepts/deployment-overview) for more + * create the version. See the [guide to model + * deployment](/ml-engine/docs/tensorflow/deploying-models) for more * information. When passing Version to * [projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create) * the model service uses the specified location as the source of the model. @@ -853,7 +863,7 @@ export interface Schema$GoogleCloudMlV1__Version { */ export interface Schema$GoogleIamV1__AuditConfig { /** - * The configuration for logging of each type of permission. Next ID: 4 + * The configuration for logging of each type of permission. */ auditLogConfigs: Schema$GoogleIamV1__AuditLogConfig[]; /** @@ -913,18 +923,22 @@ export interface Schema$GoogleIamV1__Binding { /** * 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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$GoogleIamV1__Policy { /** @@ -1129,9 +1143,9 @@ export class Resource$Projects { /** * ml.projects.getConfig * @desc Get the service account information associated with your project. You - * need this information in order to grant the service account persmissions - * for the Google Cloud Storage location where you put your model training - * code for training the model with Google Cloud Machine Learning. + * need this information in order to grant the service account permissions for + * the Google Cloud Storage location where you put your model training code + * for training the model with Google Cloud Machine Learning. * @alias ml.projects.getConfig * @memberOf! () * @@ -1483,7 +1497,7 @@ export class Resource$Projects$Jobs { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census':

gcloud ml-engine jobs list --filter='jobId:census*'

List all failed jobs with names that start with 'rnn':

gcloud ml-engine jobs list --filter='jobId:rnn* AND state:FAILED'

For more examples, see the guide to monitoring jobs. + * @param {string=} params.filter Optional. Specifies the subset of jobs to retrieve. You can filter on the value of one or more attributes of the job object. For example, retrieve jobs with a job identifier that starts with 'census':

gcloud ml-engine jobs list --filter='jobId:census*'

List all failed jobs with names that start with 'rnn':

gcloud ml-engine jobs list --filter='jobId:rnn* AND state:FAILED'

For more examples, see the guide to monitoring jobs. * @param {integer=} params.pageSize Optional. The number of jobs to retrieve per "page" of results. If there are more remaining results than this number, the response message will contain a valid value in the `next_page_token` field. The default value is 20, and the maximum page size is 100. * @param {string=} params.pageToken Optional. A page token to request the next page of results. You get the token from the `next_page_token` field of the response from the previous call. * @param {string} params.parent Required. The name of the project for which to list jobs. diff --git a/src/apis/oslogin/v1.ts b/src/apis/oslogin/v1.ts index 1146272104f..4460c3d53c4 100644 --- a/src/apis/oslogin/v1.ts +++ b/src/apis/oslogin/v1.ts @@ -118,6 +118,10 @@ export interface Schema$PosixAccount { * The path to the home directory for this account. */ homeDirectory: string; + /** + * The operating system type where this account applies. + */ + operatingSystemType: string; /** * Only one POSIX account can be marked as primary. */ diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index b446cf4acd9..8af26b1a33b 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -72,7 +72,7 @@ export class Oslogin { */ export interface Schema$Empty {} /** - * A response message for importing an SSH public key. + * A response message from importing an SSH public key. */ export interface Schema$ImportSshPublicKeyResponse { /** @@ -118,6 +118,10 @@ export interface Schema$PosixAccount { * The path to the home directory for this account. */ homeDirectory: string; + /** + * The operating system type where this account applies. + */ + operatingSystemType: string; /** * Only one POSIX account can be marked as primary. */ diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index 72aa1e691b5..b4b6d5b4e71 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -118,6 +118,10 @@ export interface Schema$PosixAccount { * The path to the home directory for this account. */ homeDirectory: string; + /** + * The operating system type where this account applies. + */ + operatingSystemType: string; /** * Only one POSIX account can be marked as primary. */ diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index c7112e31c98..31b76108e28 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Pub/Sub API + * Cloud Pub/Sub API * * Provides reliable, many-to-many, asynchronous messaging between applications. * diff --git a/src/apis/pubsub/v1beta1a.ts b/src/apis/pubsub/v1beta1a.ts index af7adb48686..eee14230324 100644 --- a/src/apis/pubsub/v1beta1a.ts +++ b/src/apis/pubsub/v1beta1a.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Pub/Sub API + * Cloud Pub/Sub API * * Provides reliable, many-to-many, asynchronous messaging between applications. * diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index 08863954462..50c1268534b 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Pub/Sub API + * Cloud Pub/Sub API * * Provides reliable, many-to-many, asynchronous messaging between applications. * diff --git a/src/apis/runtimeconfig/v1.ts b/src/apis/runtimeconfig/v1.ts index 872ef89120e..4f8bb61ff45 100644 --- a/src/apis/runtimeconfig/v1.ts +++ b/src/apis/runtimeconfig/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Runtime Configuration API + * Cloud Runtime Configuration API * * The Runtime Configurator allows you to dynamically configure and expose * variables through Google Cloud Platform. In addition, you can also set diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index e76ecff81e3..3850d8b05da 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Cloud Runtime Configuration API + * Cloud Runtime Configuration API * * The Runtime Configurator allows you to dynamically configure and expose * variables through Google Cloud Platform. In addition, you can also set @@ -230,18 +230,22 @@ export interface Schema$Operation { /** * 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index e57a5715ba6..e1204bb3e60 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -658,9 +658,10 @@ export interface Schema$ScriptStackTraceElement { */ export interface Schema$Status { /** - * The status code. For this API, this value either: <ul> <li> 3, - * indicating an `INVALID_ARGUMENT` error, or</li> <li> 1, - * indicating a `CANCELLED` execution.</li> </ul> + * The status code. For this API, this value either: <ul> <li> 10, + * indicating a `SCRIPT_TIMEOUT` error,</li> <li> 3, indicating an + * `INVALID_ARGUMENT` error, or</li> <li> 1, indicating a + * `CANCELLED` execution.</li> </ul> */ code: number; /** diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 4ce9bb41bc7..a70ef74d322 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Service Control API + * Service Control API * * Google Service Control provides control plane functionality to managed * services, such as logging, monitoring, and status checks. @@ -713,7 +713,8 @@ export interface Schema$Operation { */ resourceContainer: string; /** - * The resources that are involved in the operation. + * The resources that are involved in the operation. The maximum supported + * number of entries in this field is 100. */ resources: Schema$ResourceInfo[]; /** diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 35830cb7cee..dae9ff7978b 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -29,7 +29,7 @@ import {createAPIRequest} from '../../lib/apirequest'; // tslint:disable: jsdoc-format /** - * Google Service Management API + * Service Management API * * Google Service Management allows service producers to publish their services * on Google Cloud Platform so that they can be discovered and used by service @@ -1817,18 +1817,22 @@ export interface 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`, + * 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. - * **Example** { "bindings": [ { "role": - * "roles/owner", "members": [ + * **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", ] }, { + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { * "role": "roles/viewer", "members": - * ["user:sean@example.com"] } ] } For a - * description of IAM and its features, see the [IAM developer's - * guide](https://cloud.google.com/iam/docs). + * ["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 { /** diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 65abbfbe66a..9eb06540c45 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -395,6 +395,11 @@ export interface Schema$BasicChartDomain { * "High Price", "Low Price" and "Close Price". */ export interface Schema$BasicChartSeries { + /** + * The color for elements (i.e. bars, lines, points) associated with this + * series. If empty, a default color will be used. + */ + color: Schema$Color; /** * The line style of this series. Valid only if the chartType is AREA, LINE, * or SCATTER. COMBO charts are also supported if the series chart type is diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index 2a90dd2a61c..dc51b6f9278 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -955,7 +955,7 @@ export interface Schema$LayoutReference { } /** * A PageElement kind representing a non-connector line, straight connector, - * curved connector or bent connector. + * curved connector, or bent connector. */ export interface Schema$Line { /** @@ -1547,6 +1547,8 @@ export interface Schema$RefreshSheetsChartRequest { } /** * Replaces all shapes that match the given criteria with the provided image. + * The images replacing the shapes are rectangular after being inserted into the + * presentation and do not take on the forms of the shapes. */ export interface Schema$ReplaceAllShapesWithImageRequest { /** diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 83400b7640d..dc749588edc 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -279,15 +279,15 @@ export interface Schema$Empty {} */ export interface Schema$ExecuteSqlRequest { /** - * The SQL query string can contain parameter placeholders. A parameter - * placeholder consists of `'@'` followed by the parameter name. - * Parameter names consist of any combination of letters, numbers, and - * underscores. Parameters can appear anywhere that a literal value is - * expected. The same parameter name can be used more than once, for example: - * `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an - * error to execute an SQL query with unbound parameters. Parameter values - * are specified using `params`, which is a JSON object whose keys are - * parameter names, and whose values are the corresponding parameter values. + * The SQL string can contain parameter placeholders. A parameter placeholder + * consists of `'@'` followed by the parameter name. Parameter names + * consist of any combination of letters, numbers, and underscores. Parameters + * can appear anywhere that a literal value is expected. The same parameter + * name can be used more than once, for example: `"WHERE id > + * @msg_id AND id < @msg_id + 100"` It is an error to execute an SQL + * statement with unbound parameters. Parameter values are specified using + * `params`, which is a JSON object whose keys are parameter names, and whose + * values are the corresponding parameter values. */ params: any; /** @@ -295,8 +295,8 @@ export interface Schema$ExecuteSqlRequest { * from a JSON value. For example, values of type `BYTES` and values of type * `STRING` both appear in params as JSON strings. In these cases, * `param_types` can be used to specify the exact SQL type for some or all of - * the SQL query parameters. See the definition of Type for more information - * about SQL types. + * the SQL statement parameters. See the definition of Type for more + * information about SQL types. */ paramTypes: any; /** @@ -313,15 +313,15 @@ export interface Schema$ExecuteSqlRequest { */ queryMode: string; /** - * If this request is resuming a previously interrupted SQL query execution, - * `resume_token` should be copied from the last PartialResultSet yielded - * before the interruption. Doing this enables the new SQL query execution to - * resume where the last one left off. The rest of the request parameters must - * exactly match the request that yielded this token. + * If this request is resuming a previously interrupted SQL statement + * execution, `resume_token` should be copied from the last PartialResultSet + * yielded before the interruption. Doing this enables the new SQL statement + * execution to resume where the last one left off. The rest of the request + * parameters must exactly match the request that yielded this token. */ resumeToken: string; /** - * Required. The SQL query string. + * Required. The SQL string. */ sql: string; /** @@ -693,7 +693,7 @@ export interface Schema$PartialResultSet { */ resumeToken: string; /** - * Query plan and execution statistics for the query that produced this + * Query plan and execution statistics for the statement that produced this * streaming result set. These can be requested by setting * ExecuteSqlRequest.query_mode and are sent only once with the last response * in the stream. @@ -1098,8 +1098,9 @@ export interface Schema$ResultSet { */ rows: any[][]; /** - * Query plan and execution statistics for the query that produced this result - * set. These can be requested by setting ExecuteSqlRequest.query_mode. + * Query plan and execution statistics for the SQL statement that produced + * this result set. These can be requested by setting + * ExecuteSqlRequest.query_mode. */ stats: Schema$ResultSetStats; } @@ -1323,7 +1324,7 @@ export interface Schema$Transaction { * 2. Snapshot read-only. This transaction type provides guaranteed consistency * across several reads, but does not allow writes. Snapshot read-only * transactions can be configured to read at timestamps in the past. - * Snapshot read-only transactions do not need to be committed. For + * Snapshot read-only transactions do not need to be committed. For * transactions that only read, snapshot read-only transactions provide simpler * semantics and are almost always faster. In particular, read-only transactions * do not take locks, so they do not conflict with read-write transactions. As a @@ -1434,7 +1435,7 @@ export interface Schema$Transaction { * reads at read timestamps more than one hour in the past. This restriction * also applies to in-progress reads and/or SQL queries whose timestamp become * too old while executing. Reads and SQL queries with too-old read timestamps - * fail with the error `FAILED_PRECONDITION`. + * fail with the error `FAILED_PRECONDITION`. ## */ export interface Schema$TransactionOptions { /** @@ -3256,11 +3257,11 @@ export class Resource$Projects$Instances$Databases$Sessions { /** * spanner.projects.instances.databases.sessions.executeSql - * @desc Executes an SQL query, returning all rows in a single reply. This - * method cannot be used to return a result set larger than 10 MiB; if the - * query yields more data than that, the query fails with a - * `FAILED_PRECONDITION` error. Queries inside read-write transactions might - * return `ABORTED`. If this occurs, the application should restart the + * @desc Executes an SQL statement, returning all results in a single reply. + * This method cannot be used to return a result set larger than 10 MiB; if + * the query yields more data than that, the query fails with a + * `FAILED_PRECONDITION` error. Operations inside read-write transactions + * might return `ABORTED`. If this occurs, the application should restart the * transaction from the beginning. See Transaction for more details. Larger * result sets can be fetched in streaming fashion by calling * ExecuteStreamingSql instead. diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index f7f4e6fe447..c7936435e56 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -117,7 +117,8 @@ export interface Schema$Date { */ day: number; /** - * Month of year. Must be from 1 to 12. + * Month of year. Must be from 1 to 12, or 0 if specifying a date without a + * month. */ month: number; /** diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts new file mode 100644 index 00000000000..3a4a356d847 --- /dev/null +++ b/src/apis/videointelligence/v1.ts @@ -0,0 +1,1544 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; + +import {GoogleApis} from '../..'; +import {BodyResponseCallback, GlobalOptions, MethodOptions} from '../../lib/api'; +import {createAPIRequest} from '../../lib/apirequest'; + +// TODO: We will eventually get the `any` in here cleared out, but in the +// interim we want to turn on no-implicit-any. + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format + +/** + * Cloud Video Intelligence API + * + * Cloud Video Intelligence API. + * + * @example + * const google = require('googleapis'); + * const videointelligence = google.videointelligence('v1'); + * + * @namespace videointelligence + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Videointelligence + */ +export class Videointelligence { + _options: GlobalOptions; + google: GoogleApis; + root = this; + + operations: Resource$Operations; + videos: Resource$Videos; + + constructor(options: GlobalOptions, google: GoogleApis) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.operations = new Resource$Operations(this); + this.videos = new Resource$Videos(this); + } + + getRoot() { + return this.root; + } +} + +/** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress: + Schema$GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress[]; +} +/** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults: + Schema$GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults[]; +} +/** + * Label annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_LabelAnnotation { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode: string; + /** + * Where the label was detected and with what confidence. + */ + locations: Schema$GoogleCloudVideointelligenceV1beta1_LabelLocation[]; +} +/** + * Label location. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_LabelLocation { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Label level. + */ + level: string; + /** + * Video segment. Set to [-1, -1] for video-level labels. Set to [timestamp, + * timestamp] for frame-level labels. Otherwise, corresponds to one of + * `AnnotateSpec.segments` (if specified) or to shot boundaries (if + * requested). + */ + segment: Schema$GoogleCloudVideointelligenceV1beta1_VideoSegment; +} +/** + * Safe search annotation (based on per-frame visual signals only). If no unsafe + * content has been detected in a frame, no annotations are present for that + * frame. If only some types of unsafe content have been detected in a frame, + * the likelihood is set to `UNKNOWN` for all other types of unsafe content. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation { + /** + * Likelihood of adult content. + */ + adult: string; + /** + * Likelihood of medical content. + */ + medical: string; + /** + * Likelihood of racy content. + */ + racy: string; + /** + * Likelihood that an obvious modification was made to the original version to + * make it appear funny or offensive. + */ + spoof: string; + /** + * Video time offset in microseconds. + */ + timeOffset: string; + /** + * Likelihood of violent content. + */ + violent: string; +} +/** + * Annotation progress for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when fully + * processed. + */ + progressPercent: number; + /** + * Time when the request was received. + */ + startTime: string; + /** + * Time of the most recent update. + */ + updateTime: string; +} +/** + * Annotation results for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error: Schema$GoogleRpc_Status; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Label annotations. There is exactly one element for each unique label. + */ + labelAnnotations: + Schema$GoogleCloudVideointelligenceV1beta1_LabelAnnotation[]; + /** + * Safe search annotations. + */ + safeSearchAnnotations: + Schema$GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations: Schema$GoogleCloudVideointelligenceV1beta1_VideoSegment[]; +} +/** + * Video segment. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_VideoSegment { + /** + * End offset in microseconds (inclusive). Unset means 0. + */ + endTimeOffset: string; + /** + * Start offset in microseconds (inclusive). Unset means 0. + */ + startTimeOffset: string; +} +/** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress: + Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress[]; +} +/** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults: + Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults[]; +} +/** + * Detected entity from video analysis. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode: string; +} +/** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present for + * that frame. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame[]; +} +/** + * Video frame level annotation results for explicit content. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Label annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is `Terrier` + * the category is likely `dog`. And in some cases there might be more than + * one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; + /** + * Detected entity. + */ + entity: Schema$GoogleCloudVideointelligenceV1beta2_Entity; + /** + * All video frames where a label was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1beta2_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments: Schema$GoogleCloudVideointelligenceV1beta2_LabelSegment[]; +} +/** + * Video frame level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Video segment level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Video segment where a label was detected. + */ + segment: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; +} +/** + * Annotation progress for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when fully + * processed. + */ + progressPercent: number; + /** + * Time when the request was received. + */ + startTime: string; + /** + * Time of the most recent update. + */ + updateTime: string; +} +/** + * Annotation results for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation: + Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Label annotations on video level or user specified segment level. There is + * exactly one element for each unique label. + */ + segmentLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; +} +/** + * Video segment. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset: string; +} +/** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress: + Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress[]; +} +/** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults: + Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults[]; +} +/** + * Emotion attribute. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_EmotionAttribute { + /** + * Emotion entry. + */ + emotion: string; + /** + * Confidence score. + */ + score: number; +} +/** + * Detected entity from video analysis. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode: string; +} +/** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present for + * that frame. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentFrame[]; +} +/** + * Video frame level annotation results for explicit content. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Face detection annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAnnotation { + /** + * All video frames where a face was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionFrame[]; + /** + * All video segments where a face was detected. + */ + segments: Schema$GoogleCloudVideointelligenceV1p1beta1_FaceSegment[]; +} +/** + * Face detection attribute. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAttribute { + /** + * Emotion attributes. + */ + emotions: Schema$GoogleCloudVideointelligenceV1p1beta1_EmotionAttribute[]; + /** + * Normalized Bounding box. + */ + normalizedBoundingBox: + Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox; +} +/** + * Video frame level annotation results for face detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionFrame { + /** + * Face attributes in a frame. There can be more than one attributes if the + * same face is detected in multiple locations within the current frame. + */ + attributes: + Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAttribute[]; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Video segment level annotation results for face detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_FaceSegment { + /** + * Video segment where a face was detected. + */ + segment: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; +} +/** + * Label annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is `Terrier` + * the category is likely `dog`. And in some cases there might be more than + * one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; + /** + * Detected entity. + */ + entity: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity; + /** + * All video frames where a label was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelSegment[]; +} +/** + * Video frame level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Video segment level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Video segment where a label was detected. + */ + segment: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; +} +/** + * Normalized bounding box. The normalized vertex coordinates are relative to + * the original image. Range: [0, 1]. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox { + /** + * Bottom Y coordinate. + */ + bottom: number; + /** + * Left X coordinate. + */ + left: number; + /** + * Right X coordinate. + */ + right: number; + /** + * Top Y coordinate. + */ + top: number; +} +/** + * Alternative hypotheses (a.k.a. n-best list). + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is typically provided only for the top hypothesis, and + * only for `is_final=true` results. Clients should not rely on the + * `confidence` field as it is not guaranteed to be accurate or consistent. + * The default of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence: number; + /** + * Output only. Transcript text representing the words that the user spoke. + */ + transcript: string; + /** + * Output only. A list of word-specific information for each recognized word. + */ + words: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; +} +/** + * A speech recognition result corresponding to a portion of the audio. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { + /** + * Output only. May contain one or more recognition hypotheses (up to the + * maximum specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + // clang-format off + alternatives: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; + // clang-format on +} +/** + * Annotation progress for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when fully + * processed. + */ + progressPercent: number; + /** + * Time when the request was received. + */ + startTime: string; + /** + * Time of the most recent update. + */ + updateTime: string; +} +/** + * Annotation results for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation: + Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation; + /** + * Face detection annotations. + */ + faceDetectionAnnotations: + Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAnnotation[]; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Label annotations on video level or user specified segment level. There is + * exactly one element for each unique label. + */ + segmentLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions: + Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription[]; +} +/** + * Video segment. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset: string; +} +/** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { + /** + * Output only. Time offset relative to the beginning of the audio, and + * corresponding to the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is an + * experimental feature and the accuracy of the time offset can vary. + */ + endTime: string; + /** + * Output only. Time offset relative to the beginning of the audio, and + * corresponding to the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is an + * experimental feature and the accuracy of the time offset can vary. + */ + startTime: string; + /** + * Output only. The word corresponding to this set of information. + */ + word: string; +} +/** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress: + Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress[]; +} +/** + * Video annotation request. + */ +export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoRequest { + /** + * Requested video annotation features. + */ + features: string[]; + /** + * The video data bytes. If unset, the input video(s) should be specified via + * `input_uri`. If set, `input_uri` should be unset. + */ + inputContent: string; + /** + * Input video location. 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). A video URI may include + * wildcards in `object-id`, and thus identify multiple videos. Supported + * wildcards: '*' to match 0 or more characters; '?' to match + * 1 character. If unset, the input video should be embedded in the request as + * `input_content`. If set, `input_content` should be unset. + */ + inputUri: string; + /** + * 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; + /** + * 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; + /** + * Additional video context and/or feature-specific parameters. + */ + videoContext: Schema$GoogleCloudVideointelligenceV1_VideoContext; +} +/** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults: + Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults[]; +} +/** + * Detected entity from video analysis. + */ +export interface Schema$GoogleCloudVideointelligenceV1_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode: string; +} +/** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present for + * that frame. + */ +export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1_ExplicitContentFrame[]; +} +/** + * Config for EXPLICIT_CONTENT_DETECTION. + */ +export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentDetectionConfig { + /** + * Model to use for explicit content detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model: string; +} +/** + * Video frame level annotation results for explicit content. + */ +export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Label annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is `Terrier` + * the category is likely `dog`. And in some cases there might be more than + * one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities: Schema$GoogleCloudVideointelligenceV1_Entity[]; + /** + * Detected entity. + */ + entity: Schema$GoogleCloudVideointelligenceV1_Entity; + /** + * All video frames where a label was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments: Schema$GoogleCloudVideointelligenceV1_LabelSegment[]; +} +/** + * Config for LABEL_DETECTION. + */ +export interface Schema$GoogleCloudVideointelligenceV1_LabelDetectionConfig { + /** + * What labels should be detected with LABEL_DETECTION, in addition to + * video-level labels or segment-level labels. If unspecified, defaults to + * `SHOT_MODE`. + */ + labelDetectionMode: string; + /** + * Model to use for label detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model: string; + /** + * Whether the video has been shot from a stationary (i.e. non-moving) camera. + * When set to true, might improve detection accuracy for moving objects. + * Should be used with `SHOT_AND_FRAME_MODE` enabled. + */ + stationaryCamera: boolean; +} +/** + * Video frame level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Video segment level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Video segment where a label was detected. + */ + segment: Schema$GoogleCloudVideointelligenceV1_VideoSegment; +} +/** + * Config for SHOT_CHANGE_DETECTION. + */ +export interface Schema$GoogleCloudVideointelligenceV1_ShotChangeDetectionConfig { + /** + * Model to use for shot change detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model: string; +} +/** + * Annotation progress for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when fully + * processed. + */ + progressPercent: number; + /** + * Time when the request was received. + */ + startTime: string; + /** + * Time of the most recent update. + */ + updateTime: string; +} +/** + * Annotation results for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation: + Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Label annotations on video level or user specified segment level. There is + * exactly one element for each unique label. + */ + segmentLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; +} +/** + * Video context and/or feature-specific parameters. + */ +export interface Schema$GoogleCloudVideointelligenceV1_VideoContext { + /** + * Config for EXPLICIT_CONTENT_DETECTION. + */ + explicitContentDetectionConfig: + Schema$GoogleCloudVideointelligenceV1_ExplicitContentDetectionConfig; + /** + * Config for LABEL_DETECTION. + */ + labelDetectionConfig: + Schema$GoogleCloudVideointelligenceV1_LabelDetectionConfig; + /** + * Video segments to annotate. The segments may overlap and are not required + * to be contiguous or span the whole video. If unspecified, each video is + * treated as a single segment. + */ + segments: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; + /** + * Config for SHOT_CHANGE_DETECTION. + */ + shotChangeDetectionConfig: + Schema$GoogleCloudVideointelligenceV1_ShotChangeDetectionConfig; +} +/** + * Video segment. + */ +export interface Schema$GoogleCloudVideointelligenceV1_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset: string; +} +/** + * The request message for Operations.CancelOperation. + */ +export interface Schema$GoogleLongrunning_CancelOperationRequest {} +/** + * The response message for Operations.ListOperations. + */ +export interface Schema$GoogleLongrunning_ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken: string; + /** + * A list of operations that matches the specified filter in the request. + */ + operations: Schema$GoogleLongrunning_Operation[]; +} +/** + * This resource represents a long-running operation that is the result of a + * network API call. + */ +export interface Schema$GoogleLongrunning_Operation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error: Schema$GoogleRpc_Status; + /** + * Service-specific metadata associated with the operation. It typically + * contains progress information and common metadata such as create time. Some + * services might not provide such metadata. Any method that returns a + * long-running operation should document the metadata type, if any. + */ + metadata: any; + /** + * The server-assigned name, which is only unique within the same service that + * originally returns it. If you use the default HTTP mapping, the `name` + * should have the format of `operations/some/unique/name`. + */ + name: string; + /** + * The normal response of the operation in case of success. If the original + * method returns no data on success, such as `Delete`, the response is + * `google.protobuf.Empty`. If the original method is standard + * `Get`/`Create`/`Update`, the response should be the resource. For other + * methods, the response should have the type `XxxResponse`, where `Xxx` is + * the original method name. For example, if the original method name is + * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response: any; +} +/** + * A generic empty message that you can re-use to avoid defining duplicated + * empty messages in your APIs. A typical example is to use it as the request or + * the response type of an API method. For instance: service Foo { rpc + * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON + * representation for `Empty` is empty JSON object `{}`. + */ +export interface Schema$GoogleProtobuf_Empty {} +/** + * The `Status` type defines a logical error model that is suitable for + * different programming environments, including REST APIs and RPC APIs. It is + * used by [gRPC](https://github.com/grpc). The error model is designed to be: + * - Simple to use and understand for most users - Flexible enough to meet + * unexpected needs # Overview The `Status` message contains three pieces of + * data: error code, error message, and error details. The error code should be + * an enum value of google.rpc.Code, but it may accept additional error codes if + * needed. The error message should be a developer-facing English message that + * helps developers *understand* and *resolve* the error. If a localized + * user-facing error message is needed, put the localized message in the error + * details or localize it in the client. The optional error details may contain + * arbitrary information about the error. There is a predefined set of error + * detail types in the package `google.rpc` that can be used for common error + * conditions. # Language mapping The `Status` message is the logical + * representation of the error model, but it is not necessarily the actual wire + * format. When the `Status` message is exposed in different client libraries + * and different wire protocols, it can be mapped differently. For example, it + * will likely be mapped to some exceptions in Java, but more likely mapped to + * some error codes in C. # Other uses The error model and the `Status` + * message can be used in a variety of environments, either with or without + * APIs, to provide a consistent developer experience across different + * environments. Example uses of this error model include: - Partial errors. + * If a service needs to return partial errors to the client, it may embed + * the `Status` in the normal response to indicate the partial errors. - + * Workflow errors. A typical workflow has multiple steps. Each step may have a + * `Status` message for error reporting. - Batch operations. If a client uses + * batch request and batch response, the `Status` message should be used + * directly inside batch response, one for each error sub-response. - + * Asynchronous operations. If an API call embeds asynchronous operation results + * in its response, the status of those operations should be represented + * directly using the `Status` message. - Logging. If some API errors are + * stored in logs, the message `Status` could be used directly after any + * stripping needed for security/privacy reasons. + */ +export interface Schema$GoogleRpc_Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code: number; + /** + * A list of messages that carry the error details. There is a common set of + * message types for APIs to use. + */ + details: any[]; + /** + * A developer-facing error message, which should be in English. Any + * user-facing error message should be localized and sent in the + * google.rpc.Status.details field, or localized by the client. + */ + message: string; +} + +export class Resource$Operations { + root: Videointelligence; + constructor(root: Videointelligence) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * videointelligence.operations.cancel + * @desc Starts asynchronous cancellation on a long-running operation. The + * server makes a best effort to cancel the operation, but success is not + * guaranteed. If the server doesn't support this method, it returns + * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + * or other methods to check whether the cancellation succeeded or whether the + * operation completed despite cancellation. On successful cancellation, the + * operation is not deleted; instead, it becomes an operation with an + * Operation.error value with a google.rpc.Status.code of 1, corresponding to + * `Code.CANCELLED`. + * @alias videointelligence.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {().GoogleLongrunning_CancelOperationRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel(params?: any, options?: MethodOptions): + AxiosPromise; + cancel( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + cancel( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/operations/{+name}:cancel') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * videointelligence.operations.delete + * @desc Deletes a long-running operation. This method indicates that the + * client is no longer interested in the operation result. It does not cancel + * the operation. If the server doesn't support this method, it returns + * `google.rpc.Code.UNIMPLEMENTED`. + * @alias videointelligence.operations.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?: any, options?: MethodOptions): + AxiosPromise; + delete( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + delete( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/operations/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * videointelligence.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use + * this method to poll the operation result at intervals as recommended by the + * API service. + * @alias videointelligence.operations.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?: any, options?: MethodOptions): + AxiosPromise; + get(params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void; + get(params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/operations/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * videointelligence.operations.list + * @desc Lists operations that match the specified filter in the request. If + * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: + * the `name` binding allows API services to override the binding to use + * different resource name schemes, such as `users/x/operations`. To override + * the binding, API services can add a binding such as + * `"/v1/{name=users/x}/operations"` to their service configuration. For + * backwards compatibility, the default name includes the operations + * collection id, however overriding users must ensure the name binding is the + * parent resource, without the operations collection id. + * @alias videointelligence.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string=} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: any, options?: MethodOptions): + AxiosPromise; + list( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleLongrunning_ListOperationsResponse>): void; + list( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleLongrunning_ListOperationsResponse>): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/operations').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } +} + +export class Resource$Videos { + root: Videointelligence; + constructor(root: Videointelligence) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * videointelligence.videos.annotate + * @desc Performs asynchronous video annotation. Progress and results can be + * retrieved through the `google.longrunning.Operations` interface. + * `Operation.metadata` contains `AnnotateVideoProgress` (progress). + * `Operation.response` contains `AnnotateVideoResponse` (results). + * @alias videointelligence.videos.annotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudVideointelligenceV1_AnnotateVideoRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + annotate(params?: any, options?: MethodOptions): + AxiosPromise; + annotate( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void; + annotate( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + '/v1/videos:annotate').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } +} diff --git a/src/apis/videointelligence/v1beta1.ts b/src/apis/videointelligence/v1beta1.ts index 08873486553..91b489d0075 100644 --- a/src/apis/videointelligence/v1beta1.ts +++ b/src/apis/videointelligence/v1beta1.ts @@ -738,8 +738,7 @@ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscriptio * probable, as ranked by the recognizer. */ // clang-format off - alternatives: - Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; + alternatives: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; // clang-format on } /** diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts new file mode 100644 index 00000000000..00ca14b8526 --- /dev/null +++ b/src/apis/videointelligence/v1beta2.ts @@ -0,0 +1,1253 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; + +import {GoogleApis} from '../..'; +import {BodyResponseCallback, GlobalOptions, MethodOptions} from '../../lib/api'; +import {createAPIRequest} from '../../lib/apirequest'; + +// TODO: We will eventually get the `any` in here cleared out, but in the +// interim we want to turn on no-implicit-any. + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format + +/** + * Cloud Video Intelligence API + * + * Cloud Video Intelligence API. + * + * @example + * const google = require('googleapis'); + * const videointelligence = google.videointelligence('v1beta2'); + * + * @namespace videointelligence + * @type {Function} + * @version v1beta2 + * @variation v1beta2 + * @param {object=} options Options for Videointelligence + */ +export class Videointelligence { + _options: GlobalOptions; + google: GoogleApis; + root = this; + + videos: Resource$Videos; + + constructor(options: GlobalOptions, google: GoogleApis) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.videos = new Resource$Videos(this); + } + + getRoot() { + return this.root; + } +} + +/** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress: + Schema$GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress[]; +} +/** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults: + Schema$GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults[]; +} +/** + * Label annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_LabelAnnotation { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode: string; + /** + * Where the label was detected and with what confidence. + */ + locations: Schema$GoogleCloudVideointelligenceV1beta1_LabelLocation[]; +} +/** + * Label location. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_LabelLocation { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Label level. + */ + level: string; + /** + * Video segment. Set to [-1, -1] for video-level labels. Set to [timestamp, + * timestamp] for frame-level labels. Otherwise, corresponds to one of + * `AnnotateSpec.segments` (if specified) or to shot boundaries (if + * requested). + */ + segment: Schema$GoogleCloudVideointelligenceV1beta1_VideoSegment; +} +/** + * Safe search annotation (based on per-frame visual signals only). If no unsafe + * content has been detected in a frame, no annotations are present for that + * frame. If only some types of unsafe content have been detected in a frame, + * the likelihood is set to `UNKNOWN` for all other types of unsafe content. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation { + /** + * Likelihood of adult content. + */ + adult: string; + /** + * Likelihood of medical content. + */ + medical: string; + /** + * Likelihood of racy content. + */ + racy: string; + /** + * Likelihood that an obvious modification was made to the original version to + * make it appear funny or offensive. + */ + spoof: string; + /** + * Video time offset in microseconds. + */ + timeOffset: string; + /** + * Likelihood of violent content. + */ + violent: string; +} +/** + * Annotation progress for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when fully + * processed. + */ + progressPercent: number; + /** + * Time when the request was received. + */ + startTime: string; + /** + * Time of the most recent update. + */ + updateTime: string; +} +/** + * Annotation results for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error: Schema$GoogleRpc_Status; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Label annotations. There is exactly one element for each unique label. + */ + labelAnnotations: + Schema$GoogleCloudVideointelligenceV1beta1_LabelAnnotation[]; + /** + * Safe search annotations. + */ + safeSearchAnnotations: + Schema$GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations: Schema$GoogleCloudVideointelligenceV1beta1_VideoSegment[]; +} +/** + * Video segment. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta1_VideoSegment { + /** + * End offset in microseconds (inclusive). Unset means 0. + */ + endTimeOffset: string; + /** + * Start offset in microseconds (inclusive). Unset means 0. + */ + startTimeOffset: string; +} +/** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress: + Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress[]; +} +/** + * Video annotation request. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoRequest { + /** + * Requested video annotation features. + */ + features: string[]; + /** + * The video data bytes. If unset, the input video(s) should be specified via + * `input_uri`. If set, `input_uri` should be unset. + */ + inputContent: string; + /** + * Input video location. 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). A video URI may include + * wildcards in `object-id`, and thus identify multiple videos. Supported + * wildcards: '*' to match 0 or more characters; '?' to match + * 1 character. If unset, the input video should be embedded in the request as + * `input_content`. If set, `input_content` should be unset. + */ + inputUri: string; + /** + * 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; + /** + * 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; + /** + * Additional video context and/or feature-specific parameters. + */ + videoContext: Schema$GoogleCloudVideointelligenceV1beta2_VideoContext; +} +/** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults: + Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults[]; +} +/** + * Detected entity from video analysis. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode: string; +} +/** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present for + * that frame. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame[]; +} +/** + * Config for EXPLICIT_CONTENT_DETECTION. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentDetectionConfig { + /** + * Model to use for explicit content detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model: string; +} +/** + * Video frame level annotation results for explicit content. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Label annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is `Terrier` + * the category is likely `dog`. And in some cases there might be more than + * one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; + /** + * Detected entity. + */ + entity: Schema$GoogleCloudVideointelligenceV1beta2_Entity; + /** + * All video frames where a label was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1beta2_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments: Schema$GoogleCloudVideointelligenceV1beta2_LabelSegment[]; +} +/** + * Config for LABEL_DETECTION. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelDetectionConfig { + /** + * What labels should be detected with LABEL_DETECTION, in addition to + * video-level labels or segment-level labels. If unspecified, defaults to + * `SHOT_MODE`. + */ + labelDetectionMode: string; + /** + * Model to use for label detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model: string; + /** + * Whether the video has been shot from a stationary (i.e. non-moving) camera. + * When set to true, might improve detection accuracy for moving objects. + * Should be used with `SHOT_AND_FRAME_MODE` enabled. + */ + stationaryCamera: boolean; +} +/** + * Video frame level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Video segment level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Video segment where a label was detected. + */ + segment: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; +} +/** + * Config for SHOT_CHANGE_DETECTION. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_ShotChangeDetectionConfig { + /** + * Model to use for shot change detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model: string; +} +/** + * Annotation progress for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when fully + * processed. + */ + progressPercent: number; + /** + * Time when the request was received. + */ + startTime: string; + /** + * Time of the most recent update. + */ + updateTime: string; +} +/** + * Annotation results for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation: + Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Label annotations on video level or user specified segment level. There is + * exactly one element for each unique label. + */ + segmentLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; +} +/** + * Video context and/or feature-specific parameters. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoContext { + /** + * Config for EXPLICIT_CONTENT_DETECTION. + */ + explicitContentDetectionConfig: + Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentDetectionConfig; + /** + * Config for LABEL_DETECTION. + */ + labelDetectionConfig: + Schema$GoogleCloudVideointelligenceV1beta2_LabelDetectionConfig; + /** + * Video segments to annotate. The segments may overlap and are not required + * to be contiguous or span the whole video. If unspecified, each video is + * treated as a single segment. + */ + segments: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; + /** + * Config for SHOT_CHANGE_DETECTION. + */ + shotChangeDetectionConfig: + Schema$GoogleCloudVideointelligenceV1beta2_ShotChangeDetectionConfig; +} +/** + * Video segment. + */ +export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset: string; +} +/** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress: + Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress[]; +} +/** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults: + Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults[]; +} +/** + * Emotion attribute. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_EmotionAttribute { + /** + * Emotion entry. + */ + emotion: string; + /** + * Confidence score. + */ + score: number; +} +/** + * Detected entity from video analysis. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode: string; +} +/** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present for + * that frame. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentFrame[]; +} +/** + * Video frame level annotation results for explicit content. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Face detection annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAnnotation { + /** + * All video frames where a face was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionFrame[]; + /** + * All video segments where a face was detected. + */ + segments: Schema$GoogleCloudVideointelligenceV1p1beta1_FaceSegment[]; +} +/** + * Face detection attribute. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAttribute { + /** + * Emotion attributes. + */ + emotions: Schema$GoogleCloudVideointelligenceV1p1beta1_EmotionAttribute[]; + /** + * Normalized Bounding box. + */ + normalizedBoundingBox: + Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox; +} +/** + * Video frame level annotation results for face detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionFrame { + /** + * Face attributes in a frame. There can be more than one attributes if the + * same face is detected in multiple locations within the current frame. + */ + attributes: + Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAttribute[]; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Video segment level annotation results for face detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_FaceSegment { + /** + * Video segment where a face was detected. + */ + segment: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; +} +/** + * Label annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is `Terrier` + * the category is likely `dog`. And in some cases there might be more than + * one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; + /** + * Detected entity. + */ + entity: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity; + /** + * All video frames where a label was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelSegment[]; +} +/** + * Video frame level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Video segment level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Video segment where a label was detected. + */ + segment: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; +} +/** + * Normalized bounding box. The normalized vertex coordinates are relative to + * the original image. Range: [0, 1]. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox { + /** + * Bottom Y coordinate. + */ + bottom: number; + /** + * Left X coordinate. + */ + left: number; + /** + * Right X coordinate. + */ + right: number; + /** + * Top Y coordinate. + */ + top: number; +} +/** + * Alternative hypotheses (a.k.a. n-best list). + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is typically provided only for the top hypothesis, and + * only for `is_final=true` results. Clients should not rely on the + * `confidence` field as it is not guaranteed to be accurate or consistent. + * The default of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence: number; + /** + * Output only. Transcript text representing the words that the user spoke. + */ + transcript: string; + /** + * Output only. A list of word-specific information for each recognized word. + */ + words: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; +} +/** + * A speech recognition result corresponding to a portion of the audio. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { + /** + * Output only. May contain one or more recognition hypotheses (up to the + * maximum specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + // clang-format off + alternatives: Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; + // clang-format on +} +/** + * Annotation progress for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when fully + * processed. + */ + progressPercent: number; + /** + * Time when the request was received. + */ + startTime: string; + /** + * Time of the most recent update. + */ + updateTime: string; +} +/** + * Annotation results for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation: + Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation; + /** + * Face detection annotations. + */ + faceDetectionAnnotations: + Schema$GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAnnotation[]; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Label annotations on video level or user specified segment level. There is + * exactly one element for each unique label. + */ + segmentLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions: + Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription[]; +} +/** + * Video segment. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset: string; +} +/** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ +export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { + /** + * Output only. Time offset relative to the beginning of the audio, and + * corresponding to the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is an + * experimental feature and the accuracy of the time offset can vary. + */ + endTime: string; + /** + * Output only. Time offset relative to the beginning of the audio, and + * corresponding to the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is an + * experimental feature and the accuracy of the time offset can vary. + */ + startTime: string; + /** + * Output only. The word corresponding to this set of information. + */ + word: string; +} +/** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress: + Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress[]; +} +/** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ +export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults: + Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults[]; +} +/** + * Detected entity from video analysis. + */ +export interface Schema$GoogleCloudVideointelligenceV1_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode: string; +} +/** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present for + * that frame. + */ +export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1_ExplicitContentFrame[]; +} +/** + * Video frame level annotation results for explicit content. + */ +export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Label annotation. + */ +export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is `Terrier` + * the category is likely `dog`. And in some cases there might be more than + * one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities: Schema$GoogleCloudVideointelligenceV1_Entity[]; + /** + * Detected entity. + */ + entity: Schema$GoogleCloudVideointelligenceV1_Entity; + /** + * All video frames where a label was detected. + */ + frames: Schema$GoogleCloudVideointelligenceV1_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments: Schema$GoogleCloudVideointelligenceV1_LabelSegment[]; +} +/** + * Video frame level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset: string; +} +/** + * Video segment level annotation results for label detection. + */ +export interface Schema$GoogleCloudVideointelligenceV1_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence: number; + /** + * Video segment where a label was detected. + */ + segment: Schema$GoogleCloudVideointelligenceV1_VideoSegment; +} +/** + * Annotation progress for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when fully + * processed. + */ + progressPercent: number; + /** + * Time when the request was received. + */ + startTime: string; + /** + * Time of the most recent update. + */ + updateTime: string; +} +/** + * Annotation results for a single video. + */ +export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation: + Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri: string; + /** + * Label annotations on video level or user specified segment level. There is + * exactly one element for each unique label. + */ + segmentLabelAnnotations: + Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; +} +/** + * Video segment. + */ +export interface Schema$GoogleCloudVideointelligenceV1_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset: string; +} +/** + * This resource represents a long-running operation that is the result of a + * network API call. + */ +export interface Schema$GoogleLongrunning_Operation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error: Schema$GoogleRpc_Status; + /** + * Service-specific metadata associated with the operation. It typically + * contains progress information and common metadata such as create time. Some + * services might not provide such metadata. Any method that returns a + * long-running operation should document the metadata type, if any. + */ + metadata: any; + /** + * The server-assigned name, which is only unique within the same service that + * originally returns it. If you use the default HTTP mapping, the `name` + * should have the format of `operations/some/unique/name`. + */ + name: string; + /** + * The normal response of the operation in case of success. If the original + * method returns no data on success, such as `Delete`, the response is + * `google.protobuf.Empty`. If the original method is standard + * `Get`/`Create`/`Update`, the response should be the resource. For other + * methods, the response should have the type `XxxResponse`, where `Xxx` is + * the original method name. For example, if the original method name is + * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response: any; +} +/** + * The `Status` type defines a logical error model that is suitable for + * different programming environments, including REST APIs and RPC APIs. It is + * used by [gRPC](https://github.com/grpc). The error model is designed to be: + * - Simple to use and understand for most users - Flexible enough to meet + * unexpected needs # Overview The `Status` message contains three pieces of + * data: error code, error message, and error details. The error code should be + * an enum value of google.rpc.Code, but it may accept additional error codes if + * needed. The error message should be a developer-facing English message that + * helps developers *understand* and *resolve* the error. If a localized + * user-facing error message is needed, put the localized message in the error + * details or localize it in the client. The optional error details may contain + * arbitrary information about the error. There is a predefined set of error + * detail types in the package `google.rpc` that can be used for common error + * conditions. # Language mapping The `Status` message is the logical + * representation of the error model, but it is not necessarily the actual wire + * format. When the `Status` message is exposed in different client libraries + * and different wire protocols, it can be mapped differently. For example, it + * will likely be mapped to some exceptions in Java, but more likely mapped to + * some error codes in C. # Other uses The error model and the `Status` + * message can be used in a variety of environments, either with or without + * APIs, to provide a consistent developer experience across different + * environments. Example uses of this error model include: - Partial errors. + * If a service needs to return partial errors to the client, it may embed + * the `Status` in the normal response to indicate the partial errors. - + * Workflow errors. A typical workflow has multiple steps. Each step may have a + * `Status` message for error reporting. - Batch operations. If a client uses + * batch request and batch response, the `Status` message should be used + * directly inside batch response, one for each error sub-response. - + * Asynchronous operations. If an API call embeds asynchronous operation results + * in its response, the status of those operations should be represented + * directly using the `Status` message. - Logging. If some API errors are + * stored in logs, the message `Status` could be used directly after any + * stripping needed for security/privacy reasons. + */ +export interface Schema$GoogleRpc_Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code: number; + /** + * A list of messages that carry the error details. There is a common set of + * message types for APIs to use. + */ + details: any[]; + /** + * A developer-facing error message, which should be in English. Any + * user-facing error message should be localized and sent in the + * google.rpc.Status.details field, or localized by the client. + */ + message: string; +} + +export class Resource$Videos { + root: Videointelligence; + constructor(root: Videointelligence) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * videointelligence.videos.annotate + * @desc Performs asynchronous video annotation. Progress and results can be + * retrieved through the `google.longrunning.Operations` interface. + * `Operation.metadata` contains `AnnotateVideoProgress` (progress). + * `Operation.response` contains `AnnotateVideoResponse` (results). + * @alias videointelligence.videos.annotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudVideointelligenceV1beta2_AnnotateVideoRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + annotate(params?: any, options?: MethodOptions): + AxiosPromise; + annotate( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void; + annotate( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/videos:annotate') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } +} diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index f24ee04ffd3..50d1fe6040d 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -544,6 +544,77 @@ export interface Schema$Feature { */ type: string; } +/** + * Response to a single file annotation request. A file may contain one or more + * images, which individually have their own responses. + */ +export interface Schema$GoogleCloudVisionV1p2beta1AnnotateFileResponse { + /** + * Information about the file for which this response is generated. + */ + inputConfig: Schema$GoogleCloudVisionV1p2beta1InputConfig; + /** + * Individual responses to images found within the file. + */ + responses: Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse[]; +} +/** + * Response to an image annotation request. + */ +export interface Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse { + /** + * If present, contextual information is needed to understand where this image + * comes from. + */ + context: Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext; + /** + * If present, crop hints have completed successfully. + */ + cropHintsAnnotation: Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation; + /** + * 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$GoogleCloudVisionV1p2beta1FaceAnnotation[]; + /** + * 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$GoogleCloudVisionV1p2beta1TextAnnotation; + /** + * If present, image properties were extracted successfully. + */ + imagePropertiesAnnotation: Schema$GoogleCloudVisionV1p2beta1ImageProperties; + /** + * If present, label detection has completed successfully. + */ + labelAnnotations: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, landmark detection has completed successfully. + */ + landmarkAnnotations: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, logo detection has completed successfully. + */ + logoAnnotations: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, safe-search annotation has completed successfully. + */ + safeSearchAnnotation: Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation; + /** + * If present, text (OCR) detection has completed successfully. + */ + textAnnotations: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, web detection has completed successfully. + */ + webDetection: Schema$GoogleCloudVisionV1p2beta1WebDetection; +} /** * The response for a single offline file annotation request. */ @@ -564,57 +635,744 @@ export interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRespons responses: Schema$GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse[]; } /** - * The Google Cloud Storage location where the output will be written to. + * Logical element on the page. */ -export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { +export interface Schema$GoogleCloudVisionV1p2beta1Block { /** - * Google Cloud Storage URI where the results will be stored. Results will be - * in JSON format and preceded by its corresponding input URI. This field can - * either represent a single file, or a prefix for multiple outputs. Prefixes - * must end in a `/`. Examples: * File: gs://bucket-name/filename.json * - * Prefix: gs://bucket-name/prefix/here/ * File: - * gs://bucket-name/prefix/here If multiple outputs, each response is still - * AnnotateFileResponse, each of which contains some subset of the full list - * of AnnotateImageResponse. Multiple outputs can happen if, for example, the - * output JSON is too large and overflows into multiple sharded files. + * Detected block type (text, image etc) for this block. */ - uri: string; + blockType: string; + /** + * The bounding box for the block. The vertices are in the order of top-left, + * top-right, bottom-right, bottom-left. When a rotation of the bounding box + * is detected the rotation is represented as around the top-left corner as + * defined when the text is read in the 'natural' orientation. For + * example: * when the text is horizontal it might look like: 0----1 + * | | 3----2 * when it's rotated 180 degrees around the + * top-left corner it becomes: 2----3 | | 1----0 + * and the vertice order will still be (0, 1, 2, 3). + */ + boundingBox: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Confidence of the OCR results on the block. Range [0, 1]. + */ + confidence: number; + /** + * List of paragraphs in this block (if this blocks is of type text). + */ + paragraphs: Schema$GoogleCloudVisionV1p2beta1Paragraph[]; + /** + * Additional information detected for the block. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; } /** - * Contains metadata for the BatchAnnotateImages operation. + * A bounding polygon for the detected image annotation. */ -export interface Schema$GoogleCloudVisionV1p2beta1OperationMetadata { +export interface Schema$GoogleCloudVisionV1p2beta1BoundingPoly { /** - * The time when the batch request was received. + * The bounding polygon normalized vertices. */ - createTime: string; + normalizedVertices: Schema$GoogleCloudVisionV1p2beta1NormalizedVertex[]; /** - * Current state of the batch operation. + * The bounding polygon vertices. */ - state: string; + vertices: Schema$GoogleCloudVisionV1p2beta1Vertex[]; +} +/** + * Color information consists of RGB channels, score, and the fraction of the + * image that the color occupies in the image. + */ +export interface Schema$GoogleCloudVisionV1p2beta1ColorInfo { /** - * The time when the operation result was last updated. + * RGB components of the color. */ - updateTime: string; + color: Schema$Color; + /** + * The fraction of pixels the color occupies in the image. Value in range [0, + * 1]. + */ + pixelFraction: number; + /** + * Image-specific score for this color. Value in range [0, 1]. + */ + score: number; } /** - * The desired output location and metadata. + * Single crop hint that is used to generate a new crop when serving an image. */ -export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { +export interface Schema$GoogleCloudVisionV1p2beta1CropHint { /** - * The max number of response protos to put into each output JSON file on GCS. - * 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. + * The bounding polygon for the crop region. The coordinates of the bounding + * box are in the original image's scale, as returned in `ImageParams`. */ - batchSize: number; + boundingPoly: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * The Google Cloud Storage location to write the output(s) to. + * Confidence of this being a salient region. Range [0, 1]. */ - gcsDestination: Schema$GoogleCloudVisionV1p2beta1GcsDestination; + confidence: number; + /** + * Fraction of importance of this salient region with respect to the original + * image. + */ + importanceFraction: number; +} +/** + * Set of crop hints that are used to generate new crops when serving images. + */ +export interface Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation { + /** + * Crop hint results. + */ + cropHints: Schema$GoogleCloudVisionV1p2beta1CropHint[]; +} +/** + * Set of dominant colors and their corresponding scores. + */ +export interface Schema$GoogleCloudVisionV1p2beta1DominantColorsAnnotation { + /** + * RGB color values with their score and pixel fraction. + */ + colors: Schema$GoogleCloudVisionV1p2beta1ColorInfo[]; +} +/** + * Set of detected entity features. + */ +export interface Schema$GoogleCloudVisionV1p2beta1EntityAnnotation { + /** + * Image region to which this entity belongs. Not produced for + * `LABEL_DETECTION` features. + */ + boundingPoly: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * **Deprecated. Use `score` instead.** The accuracy of the entity detection + * in an image. For example, for an image in which the "Eiffel + * Tower" entity is detected, this field represents the confidence that + * there is a tower in the query image. Range [0, 1]. + */ + confidence: number; + /** + * Entity textual description, expressed in its `locale` language. + */ + description: string; + /** + * The language code for the locale in which the entity textual `description` + * is expressed. + */ + locale: string; + /** + * The location information for the detected entity. Multiple `LocationInfo` + * elements can be present because one location may indicate the location of + * the scene in the image, and another location may indicate the location of + * the place where the image was taken. Location information is usually + * present for landmarks. + */ + locations: Schema$GoogleCloudVisionV1p2beta1LocationInfo[]; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + mid: string; + /** + * Some entities may have optional user-supplied `Property` (name/value) + * fields, such a score or string that qualifies the entity. + */ + properties: Schema$GoogleCloudVisionV1p2beta1Property[]; + /** + * Overall score of the result. Range [0, 1]. + */ + score: number; + /** + * The relevancy of the ICA (Image Content Annotation) label to the image. For + * example, the relevancy of "tower" is likely higher to an image + * containing the detected "Eiffel Tower" than to an image + * containing a detected distant towering building, even though the confidence + * that there is a tower in each image may be the same. Range [0, 1]. + */ + topicality: number; +} +/** + * A face annotation object contains the results of face detection. + */ +export interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotation { + /** + * Anger likelihood. + */ + angerLikelihood: string; + /** + * Blurred likelihood. + */ + blurredLikelihood: string; + /** + * The bounding polygon around the face. The coordinates of the bounding box + * are in the original image's scale, as returned in `ImageParams`. 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$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Detection confidence. Range [0, 1]. + */ + detectionConfidence: number; + /** + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, + * and encloses only the skin part of the face. Typically, it is used to + * eliminate the face from any image analysis that detects the "amount of + * skin" visible in an image. It is not based on the landmarker results, + * only on the initial face detection, hence the <code>fd</code> + * (face detection) prefix. + */ + fdBoundingPoly: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Headwear likelihood. + */ + headwearLikelihood: string; + /** + * Joy likelihood. + */ + joyLikelihood: string; + /** + * Face landmarking confidence. Range [0, 1]. + */ + landmarkingConfidence: number; + /** + * Detected face landmarks. + */ + landmarks: Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark[]; + /** + * Yaw angle, which indicates the leftward/rightward angle that the face is + * pointing relative to the vertical plane perpendicular to the image. Range + * [-180,180]. + */ + panAngle: number; + /** + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation + * of the face relative to the image vertical about the axis perpendicular to + * the face. Range [-180,180]. + */ + rollAngle: number; + /** + * Sorrow likelihood. + */ + sorrowLikelihood: string; + /** + * Surprise likelihood. + */ + surpriseLikelihood: string; + /** + * Pitch angle, which indicates the upwards/downwards angle that the face is + * pointing relative to the image's horizontal plane. Range [-180,180]. + */ + tiltAngle: number; + /** + * Under-exposed likelihood. + */ + underExposedLikelihood: string; +} +/** + * A face-specific landmark (for example, a face feature). + */ +export interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark { + /** + * Face landmark position. + */ + position: Schema$GoogleCloudVisionV1p2beta1Position; + /** + * Face landmark type. + */ + type: string; +} +/** + * The Google Cloud Storage location where the output will be written to. + */ +export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { + /** + * Google Cloud Storage URI where the results will be stored. Results will be + * in JSON format and preceded by its corresponding input URI. This field can + * either represent a single file, or a prefix for multiple outputs. Prefixes + * must end in a `/`. Examples: * File: gs://bucket-name/filename.json * + * Prefix: gs://bucket-name/prefix/here/ * File: + * gs://bucket-name/prefix/here If multiple outputs, each response is still + * AnnotateFileResponse, each of which contains some subset of the full list + * of AnnotateImageResponse. Multiple outputs can happen if, for example, the + * output JSON is too large and overflows into multiple sharded files. + */ + uri: string; +} +/** + * The Google Cloud Storage location where the input will be read from. + */ +export interface Schema$GoogleCloudVisionV1p2beta1GcsSource { + /** + * Google Cloud Storage URI for the input file. This must only be a Google + * Cloud Storage object. Wildcards are not currently supported. + */ + uri: string; +} +/** + * If an image was produced from a file (e.g. a PDF), this message gives + * information about the source of that image. + */ +export interface Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the + * file used to produce the image. + */ + pageNumber: number; + /** + * The URI of the file used to produce the image. + */ + uri: string; +} +/** + * Stores image properties, such as dominant colors. + */ +export interface Schema$GoogleCloudVisionV1p2beta1ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors: Schema$GoogleCloudVisionV1p2beta1DominantColorsAnnotation; +} +/** + * The desired input location and metadata. + */ +export interface Schema$GoogleCloudVisionV1p2beta1InputConfig { + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource: Schema$GoogleCloudVisionV1p2beta1GcsSource; + /** + * The type of the file. Currently only "application/pdf" and + * "image/tiff" are supported. Wildcards are not supported. + */ + mimeType: string; +} +/** + * Detected entity location information. + */ +export interface Schema$GoogleCloudVisionV1p2beta1LocationInfo { + /** + * 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$GoogleCloudVisionV1p2beta1NormalizedVertex { + /** + * X coordinate. + */ + x: number; + /** + * Y coordinate. + */ + y: number; +} +/** + * Contains metadata for the BatchAnnotateImages operation. + */ +export interface Schema$GoogleCloudVisionV1p2beta1OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime: string; + /** + * Current state of the batch operation. + */ + state: string; + /** + * The time when the operation result was last updated. + */ + updateTime: string; +} +/** + * The desired output location and metadata. + */ +export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { + /** + * The max number of response protos to put into each output JSON file on + * Google Cloud Storage. The valid range is [1, 100]. If not specified, the + * default value is 20. For example, for one pdf file with 100 pages, 100 + * response protos will be generated. If `batch_size` = 20, then 5 json files + * each containing 20 response protos will be written under the prefix + * `gcs_destination`.`uri`. Currently, batch_size only applies to + * GcsDestination, with potential future support for other output + * configurations. + */ + batchSize: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination: Schema$GoogleCloudVisionV1p2beta1GcsDestination; +} +/** + * Detected page from OCR. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks: Schema$GoogleCloudVisionV1p2beta1Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the + * unit is pixels. + */ + height: number; + /** + * Additional information detected on the page. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; + /** + * Page width. For PDFs the unit is points. For images (including TIFFs) the + * unit is pixels. + */ + width: number; +} +/** + * Structural unit of text representing a number of words in certain order. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Paragraph { + /** + * 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 vertice order will still be (0, 1, 2, 3). + */ + boundingBox: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Confidence of the OCR results for the paragraph. Range [0, 1]. + */ + confidence: number; + /** + * Additional information detected for the paragraph. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; + /** + * List of words in this paragraph. + */ + words: Schema$GoogleCloudVisionV1p2beta1Word[]; +} +/** + * 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$GoogleCloudVisionV1p2beta1Position { + /** + * X coordinate. + */ + x: number; + /** + * Y coordinate. + */ + y: number; + /** + * Z coordinate (or depth). + */ + z: number; +} +/** + * A `Property` consists of a user-supplied name/value pair. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Property { + /** + * Name of the property. + */ + name: string; + /** + * Value of numeric properties. + */ + uint64Value: string; + /** + * Value of the property. + */ + value: string; +} +/** + * Set of features pertaining to the image, computed by computer vision methods + * over safe-search verticals (for example, adult, spoof, medical, violence). + */ +export interface Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation { + /** + * Represents the adult content likelihood for the image. Adult content may + * contain elements such as nudity, pornographic images or cartoons, or sexual + * activities. + */ + adult: string; + /** + * Likelihood that this is a medical image. + */ + medical: string; + /** + * Likelihood that the request image contains racy content. Racy content may + * include (but is not limited to) skimpy or sheer clothing, strategically + * covered nudity, lewd or provocative poses, or close-ups of sensitive body + * areas. + */ + racy: string; + /** + * Spoof likelihood. The likelihood that an modification was made to the + * image's canonical version to make it appear funny or offensive. + */ + spoof: string; + /** + * Likelihood that this image contains violent content. + */ + violence: string; +} +/** + * A single symbol representation. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Symbol { + /** + * The bounding box for the symbol. The vertices are in the order of top-left, + * top-right, bottom-right, bottom-left. When a rotation of the bounding box + * is detected the rotation is represented as around the top-left corner as + * defined when the text is read in the 'natural' orientation. For + * example: * when the text is horizontal it might look like: 0----1 | + * | 3----2 * when it's rotated 180 degrees around the top-left + * corner it becomes: 2----3 | | 1----0 and the vertice + * order will still be (0, 1, 2, 3). + */ + boundingBox: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Confidence of the OCR results for the symbol. Range [0, 1]. + */ + confidence: number; + /** + * Additional information detected for the symbol. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; + /** + * The actual UTF-8 representation of the symbol. + */ + text: string; +} +/** + * TextAnnotation contains a structured representation of OCR extracted text. + * The hierarchy of an OCR extracted text structure is like this: TextAnnotation + * -> Page -> Block -> Paragraph -> Word -> Symbol Each + * structural component, starting from Page, may further have their own + * properties. Properties describe detected languages, breaks etc.. Please refer + * to the TextAnnotation.TextProperty message definition below for more detail. + */ +export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { + /** + * List of pages detected by OCR. + */ + pages: Schema$GoogleCloudVisionV1p2beta1Page[]; + /** + * UTF-8 text detected on the pages. + */ + text: string; +} +/** + * Detected start or end of a structural component. + */ +export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak { + /** + * True if break prepends the element. + */ + isPrefix: boolean; + /** + * Detected break type. + */ + type: string; +} +/** + * Detected language for a structural component. + */ +export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage { + /** + * Confidence of detected language. Range [0, 1]. + */ + confidence: number; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". + * For more information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode: string; +} +/** + * Additional information detected on the structural component. + */ +export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty { + /** + * Detected start or end of a text segment. + */ + detectedBreak: Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak; + /** + * A list of detected languages together with confidence. + */ + detectedLanguages: + Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage[]; +} +/** + * 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$GoogleCloudVisionV1p2beta1Vertex { + /** + * X coordinate. + */ + x: number; + /** + * Y coordinate. + */ + y: number; +} +/** + * Relevant information for the image from the Internet. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetection { + /** + * Best guess text labels for the request image. + */ + bestGuessLabels: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel[]; + /** + * Fully matching images from the Internet. Can include resized copies of the + * query image. + */ + fullMatchingImages: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * Web pages containing the matching images from the Internet. + */ + pagesWithMatchingImages: + Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage[]; + /** + * 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$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * The visually similar image results. + */ + visuallySimilarImages: + Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * Deduced entities from similar images on the Internet. + */ + webEntities: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebEntity[]; +} +/** + * Entity deduced from similar images on the Internet. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebEntity { + /** + * Canonical description of the entity, in English. + */ + description: string; + /** + * Opaque entity ID. + */ + entityId: string; + /** + * Overall relevancy score for the entity. Not normalized and not comparable + * across different image queries. + */ + score: number; +} +/** + * Metadata for online images. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage { + /** + * (Deprecated) Overall relevancy score for the image. + */ + score: number; + /** + * The result image URL. + */ + url: string; +} +/** + * Label to provide extra metadata for the web detection. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel { + /** + * Label for extra metadata. + */ + label: string; + /** + * The BCP-47 language code for `label`, such as "en-US" or + * "sr-Latn". For more information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode: string; +} +/** + * Metadata for web pages. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage { + /** + * Fully matching images on the page. Can include resized copies of the query + * image. + */ + fullMatchingImages: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * Title for the web page, may contain HTML markups. + */ + pageTitle: string; + /** + * Partial matching images on the page. Those images are similar enough to + * share some key-point features. For example an original image will likely + * have partial matching for its crops. + */ + partialMatchingImages: + Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * (Deprecated) Overall relevancy score for the web page. + */ + score: number; + /** + * The result web page URL. + */ + url: string; +} +/** + * A word representation. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Word { + /** + * 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 vertice + * order will still be (0, 1, 2, 3). + */ + boundingBox: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Confidence of the OCR results for the word. Range [0, 1]. + */ + confidence: number; + /** + * Additional information detected for the word. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; + /** + * List of symbols in the word. The order of the symbols follows the natural + * reading order. + */ + symbols: Schema$GoogleCloudVisionV1p2beta1Symbol[]; } /** * Client image to perform Google Cloud Vision API tasks over. diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index c6d855f442d..d9b8b7fc475 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -989,6 +989,77 @@ export interface Schema$GoogleCloudVisionV1p1beta1Word { */ symbols: Schema$GoogleCloudVisionV1p1beta1Symbol[]; } +/** + * Response to a single file annotation request. A file may contain one or more + * images, which individually have their own responses. + */ +export interface Schema$GoogleCloudVisionV1p2beta1AnnotateFileResponse { + /** + * Information about the file for which this response is generated. + */ + inputConfig: Schema$GoogleCloudVisionV1p2beta1InputConfig; + /** + * Individual responses to images found within the file. + */ + responses: Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse[]; +} +/** + * Response to an image annotation request. + */ +export interface Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse { + /** + * If present, contextual information is needed to understand where this image + * comes from. + */ + context: Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext; + /** + * If present, crop hints have completed successfully. + */ + cropHintsAnnotation: Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation; + /** + * 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$GoogleCloudVisionV1p2beta1FaceAnnotation[]; + /** + * 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$GoogleCloudVisionV1p2beta1TextAnnotation; + /** + * If present, image properties were extracted successfully. + */ + imagePropertiesAnnotation: Schema$GoogleCloudVisionV1p2beta1ImageProperties; + /** + * If present, label detection has completed successfully. + */ + labelAnnotations: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, landmark detection has completed successfully. + */ + landmarkAnnotations: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, logo detection has completed successfully. + */ + logoAnnotations: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, safe-search annotation has completed successfully. + */ + safeSearchAnnotation: Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation; + /** + * If present, text (OCR) detection has completed successfully. + */ + textAnnotations: Schema$GoogleCloudVisionV1p2beta1EntityAnnotation[]; + /** + * If present, web detection has completed successfully. + */ + webDetection: Schema$GoogleCloudVisionV1p2beta1WebDetection; +} /** * The response for a single offline file annotation request. */ @@ -1009,57 +1080,744 @@ export interface Schema$GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRespons responses: Schema$GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse[]; } /** - * The Google Cloud Storage location where the output will be written to. + * Logical element on the page. */ -export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { +export interface Schema$GoogleCloudVisionV1p2beta1Block { /** - * Google Cloud Storage URI where the results will be stored. Results will be - * in JSON format and preceded by its corresponding input URI. This field can - * either represent a single file, or a prefix for multiple outputs. Prefixes - * must end in a `/`. Examples: * File: gs://bucket-name/filename.json * - * Prefix: gs://bucket-name/prefix/here/ * File: - * gs://bucket-name/prefix/here If multiple outputs, each response is still - * AnnotateFileResponse, each of which contains some subset of the full list - * of AnnotateImageResponse. Multiple outputs can happen if, for example, the - * output JSON is too large and overflows into multiple sharded files. + * Detected block type (text, image etc) for this block. */ - uri: string; + blockType: string; + /** + * The bounding box for the block. The vertices are in the order of top-left, + * top-right, bottom-right, bottom-left. When a rotation of the bounding box + * is detected the rotation is represented as around the top-left corner as + * defined when the text is read in the 'natural' orientation. For + * example: * when the text is horizontal it might look like: 0----1 + * | | 3----2 * when it's rotated 180 degrees around the + * top-left corner it becomes: 2----3 | | 1----0 + * and the vertice order will still be (0, 1, 2, 3). + */ + boundingBox: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Confidence of the OCR results on the block. Range [0, 1]. + */ + confidence: number; + /** + * List of paragraphs in this block (if this blocks is of type text). + */ + paragraphs: Schema$GoogleCloudVisionV1p2beta1Paragraph[]; + /** + * Additional information detected for the block. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; } /** - * Contains metadata for the BatchAnnotateImages operation. + * A bounding polygon for the detected image annotation. */ -export interface Schema$GoogleCloudVisionV1p2beta1OperationMetadata { +export interface Schema$GoogleCloudVisionV1p2beta1BoundingPoly { /** - * The time when the batch request was received. + * The bounding polygon normalized vertices. */ - createTime: string; + normalizedVertices: Schema$GoogleCloudVisionV1p2beta1NormalizedVertex[]; /** - * Current state of the batch operation. + * The bounding polygon vertices. */ - state: string; + vertices: Schema$GoogleCloudVisionV1p2beta1Vertex[]; +} +/** + * Color information consists of RGB channels, score, and the fraction of the + * image that the color occupies in the image. + */ +export interface Schema$GoogleCloudVisionV1p2beta1ColorInfo { /** - * The time when the operation result was last updated. + * RGB components of the color. */ - updateTime: string; + color: Schema$Color; + /** + * The fraction of pixels the color occupies in the image. Value in range [0, + * 1]. + */ + pixelFraction: number; + /** + * Image-specific score for this color. Value in range [0, 1]. + */ + score: number; } /** - * The desired output location and metadata. + * Single crop hint that is used to generate a new crop when serving an image. */ -export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { +export interface Schema$GoogleCloudVisionV1p2beta1CropHint { /** - * The max number of response protos to put into each output JSON file on GCS. - * 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. + * The bounding polygon for the crop region. The coordinates of the bounding + * box are in the original image's scale, as returned in `ImageParams`. */ - batchSize: number; + boundingPoly: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** - * The Google Cloud Storage location to write the output(s) to. + * Confidence of this being a salient region. Range [0, 1]. */ - gcsDestination: Schema$GoogleCloudVisionV1p2beta1GcsDestination; + confidence: number; + /** + * Fraction of importance of this salient region with respect to the original + * image. + */ + importanceFraction: number; +} +/** + * Set of crop hints that are used to generate new crops when serving images. + */ +export interface Schema$GoogleCloudVisionV1p2beta1CropHintsAnnotation { + /** + * Crop hint results. + */ + cropHints: Schema$GoogleCloudVisionV1p2beta1CropHint[]; +} +/** + * Set of dominant colors and their corresponding scores. + */ +export interface Schema$GoogleCloudVisionV1p2beta1DominantColorsAnnotation { + /** + * RGB color values with their score and pixel fraction. + */ + colors: Schema$GoogleCloudVisionV1p2beta1ColorInfo[]; +} +/** + * Set of detected entity features. + */ +export interface Schema$GoogleCloudVisionV1p2beta1EntityAnnotation { + /** + * Image region to which this entity belongs. Not produced for + * `LABEL_DETECTION` features. + */ + boundingPoly: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * **Deprecated. Use `score` instead.** The accuracy of the entity detection + * in an image. For example, for an image in which the "Eiffel + * Tower" entity is detected, this field represents the confidence that + * there is a tower in the query image. Range [0, 1]. + */ + confidence: number; + /** + * Entity textual description, expressed in its `locale` language. + */ + description: string; + /** + * The language code for the locale in which the entity textual `description` + * is expressed. + */ + locale: string; + /** + * The location information for the detected entity. Multiple `LocationInfo` + * elements can be present because one location may indicate the location of + * the scene in the image, and another location may indicate the location of + * the place where the image was taken. Location information is usually + * present for landmarks. + */ + locations: Schema$GoogleCloudVisionV1p2beta1LocationInfo[]; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + mid: string; + /** + * Some entities may have optional user-supplied `Property` (name/value) + * fields, such a score or string that qualifies the entity. + */ + properties: Schema$GoogleCloudVisionV1p2beta1Property[]; + /** + * Overall score of the result. Range [0, 1]. + */ + score: number; + /** + * The relevancy of the ICA (Image Content Annotation) label to the image. For + * example, the relevancy of "tower" is likely higher to an image + * containing the detected "Eiffel Tower" than to an image + * containing a detected distant towering building, even though the confidence + * that there is a tower in each image may be the same. Range [0, 1]. + */ + topicality: number; +} +/** + * A face annotation object contains the results of face detection. + */ +export interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotation { + /** + * Anger likelihood. + */ + angerLikelihood: string; + /** + * Blurred likelihood. + */ + blurredLikelihood: string; + /** + * The bounding polygon around the face. The coordinates of the bounding box + * are in the original image's scale, as returned in `ImageParams`. 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$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Detection confidence. Range [0, 1]. + */ + detectionConfidence: number; + /** + * The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, + * and encloses only the skin part of the face. Typically, it is used to + * eliminate the face from any image analysis that detects the "amount of + * skin" visible in an image. It is not based on the landmarker results, + * only on the initial face detection, hence the <code>fd</code> + * (face detection) prefix. + */ + fdBoundingPoly: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Headwear likelihood. + */ + headwearLikelihood: string; + /** + * Joy likelihood. + */ + joyLikelihood: string; + /** + * Face landmarking confidence. Range [0, 1]. + */ + landmarkingConfidence: number; + /** + * Detected face landmarks. + */ + landmarks: Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark[]; + /** + * Yaw angle, which indicates the leftward/rightward angle that the face is + * pointing relative to the vertical plane perpendicular to the image. Range + * [-180,180]. + */ + panAngle: number; + /** + * Roll angle, which indicates the amount of clockwise/anti-clockwise rotation + * of the face relative to the image vertical about the axis perpendicular to + * the face. Range [-180,180]. + */ + rollAngle: number; + /** + * Sorrow likelihood. + */ + sorrowLikelihood: string; + /** + * Surprise likelihood. + */ + surpriseLikelihood: string; + /** + * Pitch angle, which indicates the upwards/downwards angle that the face is + * pointing relative to the image's horizontal plane. Range [-180,180]. + */ + tiltAngle: number; + /** + * Under-exposed likelihood. + */ + underExposedLikelihood: string; +} +/** + * A face-specific landmark (for example, a face feature). + */ +export interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark { + /** + * Face landmark position. + */ + position: Schema$GoogleCloudVisionV1p2beta1Position; + /** + * Face landmark type. + */ + type: string; +} +/** + * The Google Cloud Storage location where the output will be written to. + */ +export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { + /** + * Google Cloud Storage URI where the results will be stored. Results will be + * in JSON format and preceded by its corresponding input URI. This field can + * either represent a single file, or a prefix for multiple outputs. Prefixes + * must end in a `/`. Examples: * File: gs://bucket-name/filename.json * + * Prefix: gs://bucket-name/prefix/here/ * File: + * gs://bucket-name/prefix/here If multiple outputs, each response is still + * AnnotateFileResponse, each of which contains some subset of the full list + * of AnnotateImageResponse. Multiple outputs can happen if, for example, the + * output JSON is too large and overflows into multiple sharded files. + */ + uri: string; +} +/** + * The Google Cloud Storage location where the input will be read from. + */ +export interface Schema$GoogleCloudVisionV1p2beta1GcsSource { + /** + * Google Cloud Storage URI for the input file. This must only be a Google + * Cloud Storage object. Wildcards are not currently supported. + */ + uri: string; +} +/** + * If an image was produced from a file (e.g. a PDF), this message gives + * information about the source of that image. + */ +export interface Schema$GoogleCloudVisionV1p2beta1ImageAnnotationContext { + /** + * If the file was a PDF or TIFF, this field gives the page number within the + * file used to produce the image. + */ + pageNumber: number; + /** + * The URI of the file used to produce the image. + */ + uri: string; +} +/** + * Stores image properties, such as dominant colors. + */ +export interface Schema$GoogleCloudVisionV1p2beta1ImageProperties { + /** + * If present, dominant colors completed successfully. + */ + dominantColors: Schema$GoogleCloudVisionV1p2beta1DominantColorsAnnotation; +} +/** + * The desired input location and metadata. + */ +export interface Schema$GoogleCloudVisionV1p2beta1InputConfig { + /** + * The Google Cloud Storage location to read the input from. + */ + gcsSource: Schema$GoogleCloudVisionV1p2beta1GcsSource; + /** + * The type of the file. Currently only "application/pdf" and + * "image/tiff" are supported. Wildcards are not supported. + */ + mimeType: string; +} +/** + * Detected entity location information. + */ +export interface Schema$GoogleCloudVisionV1p2beta1LocationInfo { + /** + * 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$GoogleCloudVisionV1p2beta1NormalizedVertex { + /** + * X coordinate. + */ + x: number; + /** + * Y coordinate. + */ + y: number; +} +/** + * Contains metadata for the BatchAnnotateImages operation. + */ +export interface Schema$GoogleCloudVisionV1p2beta1OperationMetadata { + /** + * The time when the batch request was received. + */ + createTime: string; + /** + * Current state of the batch operation. + */ + state: string; + /** + * The time when the operation result was last updated. + */ + updateTime: string; +} +/** + * The desired output location and metadata. + */ +export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { + /** + * The max number of response protos to put into each output JSON file on + * Google Cloud Storage. The valid range is [1, 100]. If not specified, the + * default value is 20. For example, for one pdf file with 100 pages, 100 + * response protos will be generated. If `batch_size` = 20, then 5 json files + * each containing 20 response protos will be written under the prefix + * `gcs_destination`.`uri`. Currently, batch_size only applies to + * GcsDestination, with potential future support for other output + * configurations. + */ + batchSize: number; + /** + * The Google Cloud Storage location to write the output(s) to. + */ + gcsDestination: Schema$GoogleCloudVisionV1p2beta1GcsDestination; +} +/** + * Detected page from OCR. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Page { + /** + * List of blocks of text, images etc on this page. + */ + blocks: Schema$GoogleCloudVisionV1p2beta1Block[]; + /** + * Confidence of the OCR results on the page. Range [0, 1]. + */ + confidence: number; + /** + * Page height. For PDFs the unit is points. For images (including TIFFs) the + * unit is pixels. + */ + height: number; + /** + * Additional information detected on the page. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; + /** + * Page width. For PDFs the unit is points. For images (including TIFFs) the + * unit is pixels. + */ + width: number; +} +/** + * Structural unit of text representing a number of words in certain order. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Paragraph { + /** + * 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 vertice order will still be (0, 1, 2, 3). + */ + boundingBox: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Confidence of the OCR results for the paragraph. Range [0, 1]. + */ + confidence: number; + /** + * Additional information detected for the paragraph. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; + /** + * List of words in this paragraph. + */ + words: Schema$GoogleCloudVisionV1p2beta1Word[]; +} +/** + * 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$GoogleCloudVisionV1p2beta1Position { + /** + * X coordinate. + */ + x: number; + /** + * Y coordinate. + */ + y: number; + /** + * Z coordinate (or depth). + */ + z: number; +} +/** + * A `Property` consists of a user-supplied name/value pair. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Property { + /** + * Name of the property. + */ + name: string; + /** + * Value of numeric properties. + */ + uint64Value: string; + /** + * Value of the property. + */ + value: string; +} +/** + * Set of features pertaining to the image, computed by computer vision methods + * over safe-search verticals (for example, adult, spoof, medical, violence). + */ +export interface Schema$GoogleCloudVisionV1p2beta1SafeSearchAnnotation { + /** + * Represents the adult content likelihood for the image. Adult content may + * contain elements such as nudity, pornographic images or cartoons, or sexual + * activities. + */ + adult: string; + /** + * Likelihood that this is a medical image. + */ + medical: string; + /** + * Likelihood that the request image contains racy content. Racy content may + * include (but is not limited to) skimpy or sheer clothing, strategically + * covered nudity, lewd or provocative poses, or close-ups of sensitive body + * areas. + */ + racy: string; + /** + * Spoof likelihood. The likelihood that an modification was made to the + * image's canonical version to make it appear funny or offensive. + */ + spoof: string; + /** + * Likelihood that this image contains violent content. + */ + violence: string; +} +/** + * A single symbol representation. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Symbol { + /** + * The bounding box for the symbol. The vertices are in the order of top-left, + * top-right, bottom-right, bottom-left. When a rotation of the bounding box + * is detected the rotation is represented as around the top-left corner as + * defined when the text is read in the 'natural' orientation. For + * example: * when the text is horizontal it might look like: 0----1 | + * | 3----2 * when it's rotated 180 degrees around the top-left + * corner it becomes: 2----3 | | 1----0 and the vertice + * order will still be (0, 1, 2, 3). + */ + boundingBox: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Confidence of the OCR results for the symbol. Range [0, 1]. + */ + confidence: number; + /** + * Additional information detected for the symbol. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; + /** + * The actual UTF-8 representation of the symbol. + */ + text: string; +} +/** + * TextAnnotation contains a structured representation of OCR extracted text. + * The hierarchy of an OCR extracted text structure is like this: TextAnnotation + * -> Page -> Block -> Paragraph -> Word -> Symbol Each + * structural component, starting from Page, may further have their own + * properties. Properties describe detected languages, breaks etc.. Please refer + * to the TextAnnotation.TextProperty message definition below for more detail. + */ +export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotation { + /** + * List of pages detected by OCR. + */ + pages: Schema$GoogleCloudVisionV1p2beta1Page[]; + /** + * UTF-8 text detected on the pages. + */ + text: string; +} +/** + * Detected start or end of a structural component. + */ +export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak { + /** + * True if break prepends the element. + */ + isPrefix: boolean; + /** + * Detected break type. + */ + type: string; +} +/** + * Detected language for a structural component. + */ +export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage { + /** + * Confidence of detected language. Range [0, 1]. + */ + confidence: number; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". + * For more information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode: string; +} +/** + * Additional information detected on the structural component. + */ +export interface Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty { + /** + * Detected start or end of a text segment. + */ + detectedBreak: Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak; + /** + * A list of detected languages together with confidence. + */ + detectedLanguages: + Schema$GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage[]; +} +/** + * 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$GoogleCloudVisionV1p2beta1Vertex { + /** + * X coordinate. + */ + x: number; + /** + * Y coordinate. + */ + y: number; +} +/** + * Relevant information for the image from the Internet. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetection { + /** + * Best guess text labels for the request image. + */ + bestGuessLabels: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel[]; + /** + * Fully matching images from the Internet. Can include resized copies of the + * query image. + */ + fullMatchingImages: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * Web pages containing the matching images from the Internet. + */ + pagesWithMatchingImages: + Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage[]; + /** + * 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$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * The visually similar image results. + */ + visuallySimilarImages: + Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * Deduced entities from similar images on the Internet. + */ + webEntities: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebEntity[]; +} +/** + * Entity deduced from similar images on the Internet. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebEntity { + /** + * Canonical description of the entity, in English. + */ + description: string; + /** + * Opaque entity ID. + */ + entityId: string; + /** + * Overall relevancy score for the entity. Not normalized and not comparable + * across different image queries. + */ + score: number; +} +/** + * Metadata for online images. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage { + /** + * (Deprecated) Overall relevancy score for the image. + */ + score: number; + /** + * The result image URL. + */ + url: string; +} +/** + * Label to provide extra metadata for the web detection. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebLabel { + /** + * Label for extra metadata. + */ + label: string; + /** + * The BCP-47 language code for `label`, such as "en-US" or + * "sr-Latn". For more information, see + * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + */ + languageCode: string; +} +/** + * Metadata for web pages. + */ +export interface Schema$GoogleCloudVisionV1p2beta1WebDetectionWebPage { + /** + * Fully matching images on the page. Can include resized copies of the query + * image. + */ + fullMatchingImages: Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * Title for the web page, may contain HTML markups. + */ + pageTitle: string; + /** + * Partial matching images on the page. Those images are similar enough to + * share some key-point features. For example an original image will likely + * have partial matching for its crops. + */ + partialMatchingImages: + Schema$GoogleCloudVisionV1p2beta1WebDetectionWebImage[]; + /** + * (Deprecated) Overall relevancy score for the web page. + */ + score: number; + /** + * The result web page URL. + */ + url: string; +} +/** + * A word representation. + */ +export interface Schema$GoogleCloudVisionV1p2beta1Word { + /** + * 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 vertice + * order will still be (0, 1, 2, 3). + */ + boundingBox: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; + /** + * Confidence of the OCR results for the word. Range [0, 1]. + */ + confidence: number; + /** + * Additional information detected for the word. + */ + property: Schema$GoogleCloudVisionV1p2beta1TextAnnotationTextProperty; + /** + * List of symbols in the word. The order of the symbols follows the natural + * reading order. + */ + symbols: Schema$GoogleCloudVisionV1p2beta1Symbol[]; } /** * An object representing a latitude/longitude pair. This is expressed as a pair diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index 1e778496abe..3879a4496c2 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -146,6 +146,20 @@ export interface Schema$Color { */ red: number; } +/** + * Response to a single file annotation request. A file may contain one or more + * images, which individually have their own responses. + */ +export interface Schema$GoogleCloudVisionV1p2beta1AnnotateFileResponse { + /** + * Information about the file for which this response is generated. + */ + inputConfig: Schema$GoogleCloudVisionV1p2beta1InputConfig; + /** + * Individual responses to images found within the file. + */ + responses: Schema$GoogleCloudVisionV1p2beta1AnnotateImageResponse[]; +} /** * Request for performing Google Cloud Vision API tasks over a user-provided * image, with user-requested features. @@ -325,6 +339,10 @@ export interface Schema$GoogleCloudVisionV1p2beta1Block { * A bounding polygon for the detected image annotation. */ export interface Schema$GoogleCloudVisionV1p2beta1BoundingPoly { + /** + * The bounding polygon normalized vertices. + */ + normalizedVertices: Schema$GoogleCloudVisionV1p2beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ @@ -592,8 +610,8 @@ export interface Schema$GoogleCloudVisionV1p2beta1GcsDestination { */ export interface Schema$GoogleCloudVisionV1p2beta1GcsSource { /** - * Google Cloud Storage URI for the input file. This must only be a GCS - * object. Wildcards are not currently supported. + * Google Cloud Storage URI for the input file. This must only be a Google + * Cloud Storage object. Wildcards are not currently supported. */ uri: string; } @@ -729,6 +747,20 @@ export interface Schema$GoogleCloudVisionV1p2beta1LocationInfo { */ 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$GoogleCloudVisionV1p2beta1NormalizedVertex { + /** + * X coordinate. + */ + x: number; + /** + * Y coordinate. + */ + y: number; +} /** * Contains metadata for the BatchAnnotateImages operation. */ @@ -751,13 +783,14 @@ export interface Schema$GoogleCloudVisionV1p2beta1OperationMetadata { */ export interface Schema$GoogleCloudVisionV1p2beta1OutputConfig { /** - * The max number of response protos to put into each output JSON file on GCS. - * 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. + * 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; /** diff --git a/src/apis/youtubeAnalytics/v2.ts b/src/apis/youtubeAnalytics/v2.ts new file mode 100644 index 00000000000..8b35738d1e6 --- /dev/null +++ b/src/apis/youtubeAnalytics/v2.ts @@ -0,0 +1,845 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; + +import {GoogleApis} from '../..'; +import {BodyResponseCallback, GlobalOptions, MethodOptions} from '../../lib/api'; +import {createAPIRequest} from '../../lib/apirequest'; + +// TODO: We will eventually get the `any` in here cleared out, but in the +// interim we want to turn on no-implicit-any. + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format + +/** + * YouTube Analytics API + * + * Retrieves your YouTube Analytics data. + * + * @example + * const google = require('googleapis'); + * const youtubeAnalytics = google.youtubeAnalytics('v2'); + * + * @namespace youtubeAnalytics + * @type {Function} + * @version v2 + * @variation v2 + * @param {object=} options Options for Youtubeanalytics + */ +export class Youtubeanalytics { + _options: GlobalOptions; + google: GoogleApis; + root = this; + + groupItems: Resource$Groupitems; + groups: Resource$Groups; + reports: Resource$Reports; + + constructor(options: GlobalOptions, google: GoogleApis) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.groupItems = new Resource$Groupitems(this); + this.groups = new Resource$Groups(this); + this.reports = new Resource$Reports(this); + } + + getRoot() { + return this.root; + } +} + +/** + * Empty response. + */ +export interface Schema$EmptyResponse { + /** + * Apiary error details + */ + errors: Schema$Errors; +} +/** + * Describes one specific error. + */ +export interface Schema$ErrorProto { + /** + * Error arguments, to be used when building user-friendly error messages + * given the error domain and code. Different error codes require different + * arguments. + */ + argument: string[]; + /** + * Error code in the error domain. This should correspond to a value of the + * enum type whose name is in domain. See the core error domain in + * error_domain.proto. + */ + code: string; + /** + * Debugging information, which should not be shared externally. + */ + debugInfo: string; + /** + * Error domain. RoSy services can define their own domain and error codes. + * This should normally be the name of an enum type, such as: + * gdata.CoreErrorDomain + */ + domain: string; + /** + * A short explanation for the error, which can be shared outside Google. + * Please set domain, code and arguments whenever possible instead of this + * error message so that external APIs can build safe error messages + * themselves. External messages built in a RoSy interface will most likely + * refer to information and concepts that are not available externally and + * should not be exposed. It is safer if external APIs can understand the + * errors and decide what the error message should look like. + */ + externalErrorMessage: string; + /** + * Location of the error, as specified by the location type. If location_type + * is PATH, this should be a path to a field that's relative to the + * request, using FieldPath notation (net/proto2/util/public/field_path.h). + * Examples: authenticated_user.gaia_id resource.address[2].country + */ + location: string; + locationType: string; +} +/** + * Request Error information. The presence of an error field signals that the + * operation has failed. + */ +export interface Schema$Errors { + /** + * Global error code. Deprecated and ignored. Set custom error codes in + * ErrorProto.domain and ErrorProto.code instead. + */ + code: string; + /** + * Specific error description and codes + */ + error: Schema$ErrorProto[]; + /** + * Request identifier generated by the service, which can be used to identify + * the error in the logs + */ + requestId: string; +} +/** + * A group. + */ +export interface Schema$Group { + /** + * The `contentDetails` object contains additional information about the + * group, such as the number and type of items that it contains. + */ + contentDetails: Schema$GroupContentDetails; + /** + * Apiary error details + */ + errors: Schema$Errors; + /** + * The Etag of this resource. + */ + etag: string; + /** + * The ID that YouTube uses to uniquely identify the group. + */ + id: string; + /** + * Identifies the API resource's type. The value will be `youtube#group`. + */ + kind: string; + /** + * The `snippet` object contains basic information about the group, including + * its creation date and name. + */ + snippet: Schema$GroupSnippet; +} +/** + * A group's content details. + */ +export interface Schema$GroupContentDetails { + /** + * The number of items in the group. + */ + itemCount: string; + /** + * The type of resources that the group contains. Valid values for this + * property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` + * * `youtubePartner#asset` + */ + itemType: string; +} +/** + * A group item. + */ +export interface Schema$GroupItem { + /** + * Apiary error details + */ + errors: Schema$Errors; + /** + * The Etag of this resource. + */ + etag: string; + /** + * The ID that YouTube uses to uniquely identify the group that contains the + * item. + */ + groupId: string; + /** + * The ID that YouTube uses to uniquely identify the `channel`, `video`, + * `playlist`, or `asset` resource that is included in the group. Note that + * this ID refers specifically to the inclusion of that resource in a + * particular group and is different than the channel ID, video ID, playlist + * ID, or asset ID that uniquely identifies the resource itself. The + * `resource.id` property's value specifies the unique channel, video, + * playlist, or asset ID. + */ + id: string; + /** + * Identifies the API resource's type. The value will be + * `youtube#groupItem`. + */ + kind: string; + /** + * The `resource` object contains information that identifies the item being + * added to the group. + */ + resource: Schema$GroupItemResource; +} +export interface Schema$GroupItemResource { + /** + * The channel, video, playlist, or asset ID that YouTube uses to uniquely + * identify the item that is being added to the group. + */ + id: string; + /** + * Identifies the type of resource being added to the group. Valid values for + * this property are: * `youtube#channel` * `youtube#playlist` * + * `youtube#video` * `youtubePartner#asset` + */ + kind: string; +} +/** + * A group snippet. + */ +export interface Schema$GroupSnippet { + /** + * The date and time that the group was created. The value is specified in ISO + * 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + */ + publishedAt: string; + /** + * The group name. The value must be a non-empty string. + */ + title: string; +} +/** + * Response message for GroupsService.ListGroupItems. + */ +export interface Schema$ListGroupItemsResponse { + /** + * Apiary error details + */ + errors: Schema$Errors; + /** + * The Etag of this resource. + */ + etag: string; + /** + * A list of groups that match the API request parameters. Each item in the + * list represents a `groupItem` resource. + */ + items: Schema$GroupItem[]; + /** + * Identifies the API resource's type. The value will be + * `youtube#groupItemListResponse`. + */ + kind: string; +} +/** + * Response message for GroupsService.ListGroups. + */ +export interface Schema$ListGroupsResponse { + /** + * Apiary error details + */ + errors: Schema$Errors; + /** + * The Etag of this resource. + */ + etag: string; + /** + * A list of groups that match the API request parameters. Each item in the + * list represents a `group` resource. + */ + items: Schema$Group[]; + /** + * Identifies the API resource's type. The value will be + * `youtube#groupListResponse`. + */ + kind: string; + /** + * The token that can be used as the value of the `pageToken` parameter to + * retrieve the next page in the result set. + */ + nextPageToken: string; +} +/** + * Response message for TargetedQueriesService.Query. + */ +export interface Schema$QueryResponse { + /** + * This value specifies information about the data returned in the `rows` + * fields. Each item in the `columnHeaders` list identifies a field returned + * in the `rows` value, which contains a list of comma-delimited data. The + * `columnHeaders` list will begin with the dimensions specified in the API + * request, which will be followed by the metrics specified in the API + * request. The order of both dimensions and metrics will match the ordering + * in the API request. For example, if the API request contains the parameters + * `dimensions=ageGroup,gender&metrics=viewerPercentage`, the API response + * will return columns in this order: `ageGroup`, `gender`, + * `viewerPercentage`. + */ + columnHeaders: Schema$ResultTableColumnHeader[]; + /** + * When set, indicates that the operation failed. + */ + errors: Schema$Errors; + /** + * This value specifies the type of data included in the API response. For the + * query method, the kind property value will be + * `youtubeAnalytics#resultTable`. + */ + kind: string; + /** + * The list contains all rows of the result table. Each item in the list is an + * array that contains comma-delimited data corresponding to a single row of + * data. The order of the comma-delimited data fields will match the order of + * the columns listed in the `columnHeaders` field. If no data is available + * for the given query, the `rows` element will be omitted from the response. + * The response for a query with the `day` dimension will not contain rows for + * the most recent days. + */ + rows: any[][]; +} +/** + * The description of a column of the result table. + */ +export interface Schema$ResultTableColumnHeader { + /** + * The type of the column (`DIMENSION` or `METRIC`). + */ + columnType: string; + /** + * The type of the data in the column (`STRING`, `INTEGER`, `FLOAT`, etc.). + */ + dataType: string; + /** + * The name of the dimension or metric. + */ + name: string; +} + +export class Resource$Groupitems { + root: Youtubeanalytics; + constructor(root: Youtubeanalytics) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * youtubeAnalytics.groupItems.delete + * @desc Removes an item from a group. + * @alias youtubeAnalytics.groupItems.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.id The `id` parameter specifies the YouTube group item ID of the group item that is being deleted. + * @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: any, options?: MethodOptions): + AxiosPromise; + delete( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + delete( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://youtubeanalytics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/groupItems').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * youtubeAnalytics.groupItems.insert + * @desc Creates a group item. + * @alias youtubeAnalytics.groupItems.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. + * @param {().GroupItem} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: any, options?: MethodOptions): AxiosPromise; + insert( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + insert( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://youtubeanalytics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/groupItems').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * youtubeAnalytics.groupItems.list + * @desc Returns a collection of group items that match the API request + * parameters. + * @alias youtubeAnalytics.groupItems.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.groupId The `groupId` parameter specifies the unique ID of the group for which you want to retrieve group items. + * @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: any, options?: MethodOptions): + AxiosPromise; + list( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): void; + list( + params?: any, + options?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://youtubeanalytics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/groupItems').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } +} + +export class Resource$Groups { + root: Youtubeanalytics; + constructor(root: Youtubeanalytics) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * youtubeAnalytics.groups.delete + * @desc Deletes a group. + * @alias youtubeAnalytics.groups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.id The `id` parameter specifies the YouTube group ID of the group that is being deleted. + * @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: any, options?: MethodOptions): + AxiosPromise; + delete( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + delete( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://youtubeanalytics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/groups').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * youtubeAnalytics.groups.insert + * @desc Creates a group. + * @alias youtubeAnalytics.groups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. + * @param {().Group} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: any, options?: MethodOptions): AxiosPromise; + insert( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + insert( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://youtubeanalytics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/groups').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * youtubeAnalytics.groups.list + * @desc Returns a collection of groups that match the API request parameters. + * For example, you can retrieve all groups that the authenticated user owns, + * or you can retrieve one or more groups by their unique IDs. + * @alias youtubeAnalytics.groups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.id The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`. + * @param {boolean=} params.mine This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user. + * @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. + * @param {string=} params.pageToken The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: any, options?: MethodOptions): + AxiosPromise; + list( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + list( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://youtubeanalytics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/groups').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * youtubeAnalytics.groups.update + * @desc Modifies a group. For example, you could change a group's title. + * @alias youtubeAnalytics.groups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.onBehalfOfContentOwner This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. + * @param {().Group} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: any, options?: MethodOptions): AxiosPromise; + update( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + update( + params?: any, options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://youtubeanalytics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/groups').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } +} + +export class Resource$Reports { + root: Youtubeanalytics; + constructor(root: Youtubeanalytics) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * youtubeAnalytics.reports.query + * @desc Retrieve your YouTube Analytics reports. + * @alias youtubeAnalytics.reports.query + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.currency The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.", pattern: [A-Z]{3} + * @param {string=} params.dimensions A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+ + * @param {string=} params.endDate The end date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2} + * @param {string=} params.filters A list of filters that should be applied when retrieving YouTube Analytics data. The [Available Reports](/youtube/analytics/v2/available_reports) document identifies the dimensions that can be used to filter each report, and the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (`;`), and the returned result table will satisfy both filters. For example, a filters parameter value of `video==dMH0bHeiRNg;country==IT` restricts the result set to include data for the given video in Italy.", + * @param {string=} params.ids Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the `ids` parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+ + * @param {boolean=} params.includeHistoricalChannelData If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.", + * @param {integer=} params.maxResults The maximum number of rows to include in the response.", minValue: 1 + * @param {string=} params.metrics A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`. See the [Available Reports](/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the metrics available in each report, and see the [Metrics](/youtube/analytics/v2/dimsmets/mets) document for definitions of those metrics. required: true, pattern: [0-9a-zA-Z,]+ + * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+ + * @param {string=} params.startDate The start date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2} + * @param {integer=} params.startIndex An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1 + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + query(params?: any, options?: MethodOptions): + AxiosPromise; + query( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void; + query( + params?: any, + options?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + if (typeof options === 'function') { + callback = options; + options = {}; + } + if (typeof params === 'function') { + callback = params; + params = {}; + } + options = options || {}; + const rootUrl = + options.rootUrl || 'https://youtubeanalytics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/reports').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } +}